diff --git a/.github/workflows/build_pages.yml b/.github/workflows/build_pages.yml new file mode 100644 index 00000000..d48efb30 --- /dev/null +++ b/.github/workflows/build_pages.yml @@ -0,0 +1,26 @@ +# Based on: https://blog.elmah.io/deploying-a-mkdocs-documentation-site-with-github-actions/ +name: build +on: + push: + branches: + - main +jobs: + deploy: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + - uses: actions/setup-python@v2 + with: + python-version: 3.x + - name: Setup MkDocs + run: | + pip install mkdocs-material + pip install mkdocs-git-revision-date-localized-plugin + pip install mkdocs-include-markdown-plugin + pip install mike + pip install mkdocs-git-committers-plugin-2 + pip install mkdocs-rss-plugin + - name: Build website + run: mkdocs gh-deploy --verbose diff --git a/.gitignore b/.gitignore index 45c15053..3195cfdb 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,7 @@ _site .sass-cache .jekyll-metadata +.idea +/.jekyll-cache/ +/Gemfile.lock +/site \ No newline at end of file diff --git a/CNAME b/CNAME index 032ab1ec..c9c61f1e 100644 --- a/CNAME +++ b/CNAME @@ -1 +1 @@ -utplsql.org \ No newline at end of file +www.utplsql.org \ No newline at end of file diff --git a/README.md b/README.md index 18a1b16e..8494320b 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,179 @@ -# Maintainging the utPLSQL Website +# Maintaining the utPLSQL Website -The [utPLSQL website](https://utplsql.github.io) is powered by [Jekyll](https://jekyllrb.com/). Which generated HTML when you push a commit to [utplsql.github.io](https://github.com/utPLSQL/utPLSQL.github.io). +The [utPLSQL website](https://utplsql.github.io) is generated using [MkDocs](https://www.mkdocs.org/) and [material theme](https://squidfunk.github.io/mkdocs-material) +[Mike](https://github.com/jimporter/mike) is used for versioning of documentation see also [this page](https://squidfunk.github.io/mkdocs-material/setup/setting-up-versioning/) -This also works in harmony with the gh-pages branches on the various other repository to create a single website. For example the [utpsql](https://github.com/utPLSQL/utPLSQL) repositories [gh-pages](https://github.com/utPLSQL/utPLSQL/tree/gh-pages) branch, is visible at [https://utplsql.github.io/utPLSQL/](https://utplsql.github.io/utPLSQL/). +## How to make an announcement post. -This allows for documentation from each sub repository to host it's own documentation without having to modify the utpsql.github.io repsitory directly. +Announcements are published with the Material [blog plugin](https://squidfunk.github.io/mkdocs-material/plugins/blog/). +- Create a new post file in the [docs/announcements/posts](https://github.com/utPLSQL/utPLSQL.github.io/tree/main/docs/announcements/posts) directory, in the subfolder for the year (e.g. `2026/`), with the file name of `YYYY-MM-DD-Blog-Post-Name.md`. This file will be a standard [Markdown file](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) which can be edited with any text editor. +- Start the file with front matter: + ```yaml + --- + title: "utPLSQL v3.2.3 released" + date: + created: 2026-07-10 + categories: + - "releases" + - "utplsql-core" + description: "Optional one-line summary shown on the home page card and in search results." + pin: false + --- + ``` +- Put `` after the first paragraph - everything above it is shown as the excerpt on the [Announcements](https://www.utplsql.org/announcements/index.html) page. +- Commit and push changes to the `main` branch. +The post URL is built from the `title` (`announcements/.html`), not from the file name or folder, so posts can be moved between folders without breaking links. +Relative links inside a post (e.g. to images in `docs/assets`) are relative to the post file, so they need adjusting when a post is moved. -## How to make an announcement post. +There is no need to update `mkdocs.yml` or `index.md` - the post appears on the Announcements page and on the home page automatically. + +## Latest News on the home page + +The "Latest News" cards on the home page are generated by a custom [MkDocs hook](https://www.mkdocs.org/user-guide/configuration/#hooks): [hooks/latest_posts.py](hooks/latest_posts.py). +The Material blog plugin has no built-in way to list posts on other pages, so the hook fills that gap. + +How it works: + +- On every build, the hook replaces the `` placeholder in [docs/index.md](docs/index.md) with [Material grid cards](https://squidfunk.github.io/mkdocs-material/reference/grids/#using-card-grids) for the most recent posts. +- Posts come from the blog plugin (`config.plugins["material/blog"].blog.posts`), in the same order as on the Announcements page: pinned posts first, then newest first. Draft posts are skipped. +- Each card shows an icon based on the post category, the title, the date and categories, a short summary and a "Read more" link. The whole card is clickable. +- The summary is, in order of preference: + 1. the `description:` from the post front matter, + 2. the first paragraph before the first list - e.g. an intro sentence written above `## What's Changed` in the GitHub release notes, + 3. the list items of the release notes, joined with ` · ` and without author, PR and issue references (`by @user in #123`, `Fixed in ...`, `resolves ...`), e.g. `Fix issue with UT_TAP_REPORTER on Oracle 23.26 · Fixed support for camelCase ... · +4 more`. + + Headings, `**Full Changelog**: ...` lines, link-only lines (e.g. `[Download ...](...)`) and bare URLs are never used. The summary is trimmed to about 180 characters. +- Posts without a `description:` also get the generated summary as their ``, used by search engines. +- Release announcements generated by the release pipeline need no changes - the summary is built from the release notes automatically. + +Controlling what is shown: -Create a File in the [_posts](https://github.com/utPLSQL/utPLSQL.github.io/tree/master/_posts) directory with the file name of `YYYY-MM-DD-Blog-Post-Name.md` +- To keep a post on the home page, add `pin: true` to its front matter. Its card is shown first with the same pin badge as on the Announcements page, and the post also stays at the top of the Announcements page. Pinned posts count towards `COUNT`. Remove the flag when it should drop off. +- To control the card text, add a `description:` to the post front matter. +- The number of cards (`COUNT`), summary length (`SUMMARY_LENGTH`) and category icons (`ICONS`) are set at the top of [hooks/latest_posts.py](hooks/latest_posts.py). Icons use the [Material icon](https://squidfunk.github.io/mkdocs-material/reference/icons-emojis/) shortcode syntax. -This file will be a standard [Markdown file](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) which can be editing with any text editor although there are many offline and online editors for Markdown. +Related configuration: -The file will also need a YAML Front Matter section at the top of the file. +- `hooks:` in [mkdocs.yml](mkdocs.yml) registers the hook. +- The `attr_list`, `md_in_html` and `pymdownx.emoji` Markdown extensions in [mkdocs.yml](mkdocs.yml) are required for the cards and icons. +- The `.latest-posts` styles in [docs/stylesheets/extra.css](docs/stylesheets/extra.css) make the whole card clickable and style the date line and "Read more" link. - --- - layout: post - title: "Title of Blog Post" - date: 2016-06-20 15:00:00 -0600 - categories: moving - --- +The hook is plain Python run by MkDocs itself - no extra package needs to be installed. +Note that it relies on MkDocs hooks and on internals of the Material blog plugin, so it needs to be revisited when upgrading Material or migrating to [Zensical](https://zensical.org/). -Look at an existing post if you want an example. +## RSS feed -## How to preview site locally +Announcements are published as RSS and JSON feeds by the [mkdocs-rss-plugin](https://guts.github.io/mkdocs-rss-plugin/), configured under `rss:` in [mkdocs.yml](mkdocs.yml): -Jekyll will allow you to preview the site locally doing the following: +- [feed_rss_created.xml](https://www.utplsql.org/feed_rss_created.xml) - newest posts first (the one to subscribe to), +- [feed_rss_updated.xml](https://www.utplsql.org/feed_rss_updated.xml) - most recently updated posts first, +- `feed_json_created.json` and `feed_json_updated.json` - the same as [JSON Feed](https://www.jsonfeed.org/). -1. [Install Jekyll 3](https://jekyllrb.com/docs/installation/) -2. [Use Jekyll Serve](https://jekyllrb.com/docs/usage/) +Only posts under `docs/announcements/posts/` are included (`match_path`), up to 20 newest. +Dates come from `date.created` / `date.updated` in the post front matter (git history is used when `date.updated` is missing), and `categories` become RSS categories. +The item description is the post `description:` or the summary generated by [hooks/latest_posts.py](hooks/latest_posts.py) - the same text as on the home page card. +The feeds are linked from the home page, the Announcements page and the RSS icon in the footer, and Material adds `` to every page, so feed readers find them automatically. +## Local setup +If you want to generate and preview the website locally, you will need to have [python and pip installed](https://squidfunk.github.io/mkdocs-material/getting-started/)) +To install mkdocs required components, you need to execute the below commands from command line: +``` +pip install mkdocs-material +pip install mkdocs-git-revision-date-localized-plugin +pip install mkdocs-include-markdown-plugin +pip install mkdocs-git-committers-plugin-2 +pip install mkdocs-rss-plugin +pip install mike +``` +Once installed you can use following commands from command line: +`mkdocs serve` - will stat a local server, so you can see the web page generated locally and tet real-time updates to documentation +The pages are automatically generated on every commit to the `main` branch. +If however you would need to generate pages manually from your local copy, use the command: +`mkdocs gh-deploy`. +The generated web pages are hen visible at [utplsql.org](https://utPLSQL.org). + +Individual project documentation pages are deployed separately from the main organization page. +Each corresponding project repository needs to have its own gh-pages branch. + +utPLSQL-framework repository uses `mike` to deploy documentation for specific project version. + +Example commands to use are: + +- `mike deploy develop` - to deploy documentation for develop branch +- `mike deploy -p develop` - to deploy and push documentation for develop branch +- `mike deploy -p -u v3.1.12 latest` - to deploy and push documentation for version v3.1.12 and update the `latest` alias to point to that version + + +## Maintaining sponsors + +Public pages: `docs/sponsorship.md` (become a sponsor: tiers, routes, FAQ) and `docs/sponsors.md` (Our sponsors: the list). +Permanent archive of sponsors: `SPONSORS.md` in the utPLSQL framework repository. + +### Onboarding a sponsor + +1. Receive logo and link. Accept SVG (preferred, with text converted to outlines), or a PNG with transparent background, tightly cropped, at least 256 px high or 768 px wide (2x the large box); 1152 x 384 px (3x) is ideal. Light/dark variants if needed. If only a lockup is supplied at the 64 px (small) size, ask for the wordmark or use the name as text. +2. Store the logo in the `utPLSQL/.github` repository (the organization repository), in `.github/assets/sponsors/`, named `sponsor-.png` or `sponsor-.svg` (lowercase, hyphens; for light/dark variants `sponsor--light.svg` and `sponsor--dark.svg`). This follows the layout of the Material for MkDocs repository. All surfaces reference the file by its raw URL, `https://raw.githubusercontent.com/utPLSQL/.github/main/.github/assets/sponsors/sponsor-.`. Do not hotlink the sponsor's own site. +3. Add the entry to the matching grid in `docs/sponsors.md`. For 500 EUR and commercial sponsors also add it to the framework README, the organization profile README (`.github/profile/README.md`) and the landing page block in `docs/index.md` (marker `sponsors-landing`). 250 EUR sponsors: organization profile only. +4. Add the name and start year to `SPONSORS.md`. +5. 500 EUR and commercial sponsors: announce on LinkedIn, X and Bluesky. + +### Offboarding a sponsor + +1. At the end of the paid period plus 30 days, remove the logo from the framework README, the organization profile and the landing page. +2. If the sponsor qualifies (3 months or a commercial agreement), move the entry to the Past sponsors grid in `docs/sponsors.md`. Otherwise delete it. +3. Update `SPONSORS.md` (end year). + +Doing this by hand across four repositories drifts. Once there is a first paying sponsor, generate all blocks from one `sponsors.yml` (fields: name, url, logo, tier, start, end, status `current` or `past`) with a scheduled GitHub Action. + +### Sponsor lifecycle rules + +| State | When | Where the sponsor appears | +|----------|-----------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| Current | from the first payment (GitHub Sponsors) or from receipt of the invoice payment (direct invoice) until the end of the paid period | per tier, see the recognition table in `docs/sponsorship.md` | +| Grace | 30 days after the end of the paid period (failed card payments, late renewals) | unchanged | +| Past | after the grace period, only if the sponsor paid for at least 3 months, or had a commercial support agreement | `docs/sponsors.md` "Past sponsors" only, as a faded logo with no details. Removed from the GitHub organization profile, framework README and utplsql.org landing page. | +| Lapsed | after the grace period, sponsored for less than 3 months and no commercial agreement | removed everywhere except the archive (`SPONSORS.md` in the utPLSQL framework repository) | +| Archive | always | `SPONSORS.md`: name and year(s) only, kept permanently | + +Other rules: +- A past sponsor is removed from the Past sponsors section on request, the same day. The archive entry is also removed if they ask. +- Individuals are not listed on utplsql.org. GitHub shows public individual sponsors on the GitHub Sponsors page. +- Release notes carry a link to `https://www.utplsql.org/sponsors.html`, never a list of names. +- Commercial support never ends up in the recognition tiers by accident: someone who paid through GitHub gets recognition only, no support. Move them to a commercial agreement instead (see the channel separation in the sponsorship notes). +- The user-facing wording of these rules is the FAQ "What happens when we stop sponsoring?" in `docs/sponsorship.md`. Change both together. + +### Presentation (`docs/sponsors.md`, styles in `docs/stylesheets/extra.css`) + +Every sponsor is a clickable logo (or a text link for 100 EUR sponsors) inside a grid. No tables. All organization tiers include a backlink to the sponsor's website: every logo (company name only as a tooltip via the standard Markdown image title, `![Alt text](image "Tooltip text")`, and as the alt text for accessibility; never printed next to the logo) and every 100 EUR name is a link to the URL supplied at onboarding, opened in a new tab with `rel="noopener sponsored"` (`sponsored` marks paid placements for search engines). In READMEs use a plain Markdown link. + +| Group | Section on the page | Grid class | Logo | +|--------------------|---------------------------------|------------------------------------|------------------------------------------------| +| Commercial support | "Commercial support sponsors" | `sponsor-grid sponsor-grid--large` | 128 px high, max 384 px wide (3:1), 32 px clear space | +| 500 EUR | "Organization sponsors", first | `sponsor-grid sponsor-grid--large` | 128 px, as above | +| 250 EUR | "Organization sponsors", second | `sponsor-grid sponsor-grid--small` | 64 px high, max 192 px wide (3:1), 16 px clear space | +| 100 EUR | "Organization sponsors", last | `sponsor-grid sponsor-grid--text` | company name as a text link | +| Past | "Past sponsors" | `sponsor-grid sponsor-grid--past` | 64 px high, max 192 px wide, grayscale, 55% opacity, logo only | + +Order inside a group: by start date, oldest first. Commercial support is listed above the recognition tiers. + +Entry format (one blank-line-separated item per sponsor; `markdown` attribute is required on the div): + +```html + +``` + +For sponsors that supply separate light and dark logos, add two images with the classes `{ .logo-light }` and `{ .logo-dark }`. + +Put each group between its marker comments (`` ... ``, `` ... ``) and delete the "There are currently no ..." sentence when the first entry is added. + diff --git a/_config.yml b/_config.yml deleted file mode 100644 index 123152fb..00000000 --- a/_config.yml +++ /dev/null @@ -1,21 +0,0 @@ -# Welcome to Jekyll! -# -# This config file is meant for settings that affect your whole blog, values -# which you are expected to set up once and rarely need to edit after that. -# For technical reasons, this file is *NOT* reloaded automatically when you use -# 'jekyll serve'. If you change this file, please restart the server process. - -# Site settings -title: utPLSQL -google_analytics: UA-80445365-1 -email: -description: > # this means to ignore newlines until "baseurl:" - utPLSQL
- Unit Testing Framework for Oracle PL/SQL. -baseurl: "" # the subpath of your site, e.g. /blog -url: "https://utPLSQL.github.com" # the base hostname & protocol for your site -twitter_username: utplsql -github_username: utplsql -# Build settings -markdown: kramdown -exclude: ["README.md","dl-files"] \ No newline at end of file diff --git a/_includes/analytics.html b/_includes/analytics.html deleted file mode 100644 index d63436d9..00000000 --- a/_includes/analytics.html +++ /dev/null @@ -1,11 +0,0 @@ - - diff --git a/_includes/footer.html b/_includes/footer.html deleted file mode 100644 index 3e459186..00000000 --- a/_includes/footer.html +++ /dev/null @@ -1,29 +0,0 @@ -
- -
- - - Copyright © 2016 - {{ 'now' | date: "%Y" }} utPLSQL Project - -
diff --git a/_includes/head.html b/_includes/head.html deleted file mode 100644 index e77b4342..00000000 --- a/_includes/head.html +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - {% if page.title %}{{ page.title | escape }}{% else %}{{ site.title | escape }}{% endif %} - - - - - - -{% if jekyll.environment == 'production' %} -{% include analytics.html %} -{% endif %} - diff --git a/_includes/header.html b/_includes/header.html deleted file mode 100644 index b3f86db8..00000000 --- a/_includes/header.html +++ /dev/null @@ -1,27 +0,0 @@ - diff --git a/_includes/icon-github.html b/_includes/icon-github.html deleted file mode 100644 index e501a16b..00000000 --- a/_includes/icon-github.html +++ /dev/null @@ -1 +0,0 @@ -{% include icon-github.svg %}{{ include.username }} diff --git a/_includes/icon-github.svg b/_includes/icon-github.svg deleted file mode 100644 index 4422c4f5..00000000 --- a/_includes/icon-github.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/_includes/icon-twitter.html b/_includes/icon-twitter.html deleted file mode 100644 index e623dbd6..00000000 --- a/_includes/icon-twitter.html +++ /dev/null @@ -1 +0,0 @@ -{{ include.username }} diff --git a/_includes/icon-twitter.svg b/_includes/icon-twitter.svg deleted file mode 100644 index dcf660e7..00000000 --- a/_includes/icon-twitter.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/_layouts/default.html b/_layouts/default.html deleted file mode 100644 index e4ab96fb..00000000 --- a/_layouts/default.html +++ /dev/null @@ -1,20 +0,0 @@ - - - - {% include head.html %} - - - - {% include header.html %} - -
-
- {{ content }} -
-
- - {% include footer.html %} - - - - diff --git a/_layouts/page.html b/_layouts/page.html deleted file mode 100644 index ce233ad7..00000000 --- a/_layouts/page.html +++ /dev/null @@ -1,14 +0,0 @@ ---- -layout: default ---- -
- -
-

{{ page.title }}

-
- -
- {{ content }} -
- -
diff --git a/_layouts/post.html b/_layouts/post.html deleted file mode 100644 index 3a0fb52e..00000000 --- a/_layouts/post.html +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: default ---- -
- -
-

{{ page.title }}

- -
- -
- {{ content }} -
- -
diff --git a/_sass/_base.scss b/_sass/_base.scss deleted file mode 100644 index 0883c3cd..00000000 --- a/_sass/_base.scss +++ /dev/null @@ -1,206 +0,0 @@ -/** - * Reset some basic elements - */ -body, h1, h2, h3, h4, h5, h6, -p, blockquote, pre, hr, -dl, dd, ol, ul, figure { - margin: 0; - padding: 0; -} - - - -/** - * Basic styling - */ -body { - font: $base-font-weight #{$base-font-size}/#{$base-line-height} $base-font-family; - color: $text-color; - background-color: $background-color; - -webkit-text-size-adjust: 100%; - -webkit-font-feature-settings: "kern" 1; - -moz-font-feature-settings: "kern" 1; - -o-font-feature-settings: "kern" 1; - font-feature-settings: "kern" 1; - font-kerning: normal; -} - - - -/** - * Set `margin-bottom` to maintain vertical rhythm - */ -h1, h2, h3, h4, h5, h6, -p, blockquote, pre, -ul, ol, dl, figure, -%vertical-rhythm { - margin-bottom: $spacing-unit / 2; -} - - - -/** - * Images - */ -img { - max-width: 100%; - vertical-align: middle; -} - - - -/** - * Figures - */ -figure > img { - display: block; -} - -figcaption { - font-size: $small-font-size; -} - - - -/** - * Lists - */ -ul, ol { - margin-left: $spacing-unit; -} - -li { - > ul, - > ol { - margin-bottom: 0; - } -} - - - -/** - * Headings - */ -h1, h2, h3, h4, h5, h6 { - font-weight: $base-font-weight; -} - - - -/** - * Links - */ -a { - color: $brand-color; - text-decoration: none; - - &:visited { - color: darken($brand-color, 15%); - } - - &:hover { - color: $text-color; - text-decoration: underline; - } -} - - - -/** - * Blockquotes - */ -blockquote { - color: $grey-color; - border-left: 4px solid $grey-color-light; - padding-left: $spacing-unit / 2; - font-size: 18px; - letter-spacing: -1px; - font-style: italic; - - > :last-child { - margin-bottom: 0; - } -} - - - -/** - * Code formatting - */ -pre, -code { - font-size: 15px; - border: 1px solid $grey-color-light; - border-radius: 3px; - background-color: #eef; -} - -code { - padding: 1px 5px; -} - -pre { - padding: 8px 12px; - overflow-x: auto; - - > code { - border: 0; - padding-right: 0; - padding-left: 0; - } -} - - - -/** - * Wrapper - */ -.wrapper { - max-width: -webkit-calc(#{$content-width} - (#{$spacing-unit} * 2)); - max-width: calc(#{$content-width} - (#{$spacing-unit} * 2)); - margin-right: auto; - margin-left: auto; - padding-right: $spacing-unit; - padding-left: $spacing-unit; - @extend %clearfix; - - @include media-query($on-laptop) { - max-width: -webkit-calc(#{$content-width} - (#{$spacing-unit})); - max-width: calc(#{$content-width} - (#{$spacing-unit})); - padding-right: $spacing-unit / 2; - padding-left: $spacing-unit / 2; - } -} - - - -/** - * Clearfix - */ -%clearfix { - - &:after { - content: ""; - display: table; - clear: both; - } -} - - - -/** - * Icons - */ -.icon { - - > svg { - display: inline-block; - width: 16px; - height: 16px; - vertical-align: middle; - - path { - fill: $grey-color; - } - } -} diff --git a/_sass/_layout.scss b/_sass/_layout.scss deleted file mode 100644 index 3f803129..00000000 --- a/_sass/_layout.scss +++ /dev/null @@ -1,246 +0,0 @@ -/** - * Site header - */ -.site-header { - /*border-top: 5px solid $grey-color-dark; - border-bottom: 1px solid $grey-color-light; */ - background-color: $header-background; - min-height: 56px; - - // Positioning context for the mobile navigation icon - position: relative; -} - -.site-title { - font-size: 26px; - font-weight: 300; - line-height: 56px; - letter-spacing: -1px; - margin-bottom: 0; - float: left; - color: $header-text; - &, - &:visited { - color: $header-text; - } -} - -.site-nav { - float: right; - line-height: 56px; - - .menu-icon { - display: none; - } - - .page-link { - color: $header-text; - line-height: $base-line-height; - - // Gaps between nav items, but not on the last one - &:not(:last-child) { - margin-right: 20px; - } - } - - @include media-query($on-palm) { - position: absolute; - top: 9px; - right: $spacing-unit / 2; - background-color: $header-background; - border: 1px solid $grey-color-light; - border-radius: 5px; - text-align: right; - - .menu-icon { - display: block; - float: right; - width: 36px; - height: 26px; - line-height: 0; - padding-top: 10px; - text-align: center; - - > svg { - width: 18px; - height: 15px; - - path { - fill: $header-text; - } - } - } - - .trigger { - clear: both; - display: none; - } - - &:hover .trigger { - display: block; - padding-bottom: 5px; - } - - .page-link { - display: block; - padding: 5px 10px; - - &:not(:last-child) { - margin-right: 0; - } - margin-left: 20px; - } - } -} - - - -/** - * Site footer - */ -.site-footer { - border-top: 1px solid $grey-color-light; - padding: $spacing-unit 0; -} - -.footer-heading { - font-size: 18px; - margin-bottom: $spacing-unit / 2; -} - -.contact-list, -.social-media-list { - list-style: none; - margin-left: 0; -} - -.footer-col-wrapper { - font-size: 15px; - color: $grey-color; - margin-left: -$spacing-unit / 2; - @extend %clearfix; -} - -.footer-col { - float: left; - margin-bottom: $spacing-unit / 2; - padding-left: $spacing-unit / 2; -} - -.footer-col-1 { - width: -webkit-calc(35% - (#{$spacing-unit} / 2)); - width: calc(35% - (#{$spacing-unit} / 2)); -} - -.footer-col-2 { - width: -webkit-calc(20% - (#{$spacing-unit} / 2)); - width: calc(20% - (#{$spacing-unit} / 2)); -} - -.footer-col-3 { - width: -webkit-calc(45% - (#{$spacing-unit} / 2)); - width: calc(45% - (#{$spacing-unit} / 2)); -} - -@include media-query($on-laptop) { - .footer-col-1, - .footer-col-2 { - width: -webkit-calc(50% - (#{$spacing-unit} / 2)); - width: calc(50% - (#{$spacing-unit} / 2)); - } - - .footer-col-3 { - width: -webkit-calc(100% - (#{$spacing-unit} / 2)); - width: calc(100% - (#{$spacing-unit} / 2)); - } -} - -@include media-query($on-palm) { - .footer-col { - float: none; - width: -webkit-calc(100% - (#{$spacing-unit} / 2)); - width: calc(100% - (#{$spacing-unit} / 2)); - } -} - - - -/** - * Page content - */ -.page-content { - padding: $spacing-unit 0; -} - -.page-heading { - font-size: 20px; -} - -.post-list { - margin-left: 0; - list-style: none; - - > li { - margin-bottom: $spacing-unit; - .post-excerpt { - font-size: 16px; - font-style: italic; - } - } -} - -.post-meta { - font-size: $small-font-size; - color: $grey-color; -} - -.post-link { - display: block; - font-size: 24px; -} - - -/** - * Posts - */ -.post-header { - margin-bottom: $spacing-unit; -} - -.post-title { - font-size: 42px; - letter-spacing: -1px; - line-height: 1; - - @include media-query($on-laptop) { - font-size: 36px; - } -} - -.post-content { - margin-bottom: $spacing-unit; - - h2 { - font-size: 32px; - - @include media-query($on-laptop) { - font-size: 28px; - } - } - - h3 { - font-size: 26px; - - @include media-query($on-laptop) { - font-size: 22px; - } - } - - h4 { - font-size: 20px; - - @include media-query($on-laptop) { - font-size: 18px; - } - } -} diff --git a/_sass/_syntax-highlighting.scss b/_sass/_syntax-highlighting.scss deleted file mode 100644 index 8fac5977..00000000 --- a/_sass/_syntax-highlighting.scss +++ /dev/null @@ -1,71 +0,0 @@ -/** - * Syntax highlighting styles - */ -.highlight { - background: #fff; - @extend %vertical-rhythm; - - .highlighter-rouge & { - background: #eef; - } - - .c { color: #998; font-style: italic } // Comment - .err { color: #a61717; background-color: #e3d2d2 } // Error - .k { font-weight: bold } // Keyword - .o { font-weight: bold } // Operator - .cm { color: #998; font-style: italic } // Comment.Multiline - .cp { color: #999; font-weight: bold } // Comment.Preproc - .c1 { color: #998; font-style: italic } // Comment.Single - .cs { color: #999; font-weight: bold; font-style: italic } // Comment.Special - .gd { color: #000; background-color: #fdd } // Generic.Deleted - .gd .x { color: #000; background-color: #faa } // Generic.Deleted.Specific - .ge { font-style: italic } // Generic.Emph - .gr { color: #a00 } // Generic.Error - .gh { color: #999 } // Generic.Heading - .gi { color: #000; background-color: #dfd } // Generic.Inserted - .gi .x { color: #000; background-color: #afa } // Generic.Inserted.Specific - .go { color: #888 } // Generic.Output - .gp { color: #555 } // Generic.Prompt - .gs { font-weight: bold } // Generic.Strong - .gu { color: #aaa } // Generic.Subheading - .gt { color: #a00 } // Generic.Traceback - .kc { font-weight: bold } // Keyword.Constant - .kd { font-weight: bold } // Keyword.Declaration - .kp { font-weight: bold } // Keyword.Pseudo - .kr { font-weight: bold } // Keyword.Reserved - .kt { color: #458; font-weight: bold } // Keyword.Type - .m { color: #099 } // Literal.Number - .s { color: #d14 } // Literal.String - .na { color: #008080 } // Name.Attribute - .nb { color: #0086B3 } // Name.Builtin - .nc { color: #458; font-weight: bold } // Name.Class - .no { color: #008080 } // Name.Constant - .ni { color: #800080 } // Name.Entity - .ne { color: #900; font-weight: bold } // Name.Exception - .nf { color: #900; font-weight: bold } // Name.Function - .nn { color: #555 } // Name.Namespace - .nt { color: #000080 } // Name.Tag - .nv { color: #008080 } // Name.Variable - .ow { font-weight: bold } // Operator.Word - .w { color: #bbb } // Text.Whitespace - .mf { color: #099 } // Literal.Number.Float - .mh { color: #099 } // Literal.Number.Hex - .mi { color: #099 } // Literal.Number.Integer - .mo { color: #099 } // Literal.Number.Oct - .sb { color: #d14 } // Literal.String.Backtick - .sc { color: #d14 } // Literal.String.Char - .sd { color: #d14 } // Literal.String.Doc - .s2 { color: #d14 } // Literal.String.Double - .se { color: #d14 } // Literal.String.Escape - .sh { color: #d14 } // Literal.String.Heredoc - .si { color: #d14 } // Literal.String.Interpol - .sx { color: #d14 } // Literal.String.Other - .sr { color: #009926 } // Literal.String.Regex - .s1 { color: #d14 } // Literal.String.Single - .ss { color: #990073 } // Literal.String.Symbol - .bp { color: #999 } // Name.Builtin.Pseudo - .vc { color: #008080 } // Name.Variable.Class - .vg { color: #008080 } // Name.Variable.Global - .vi { color: #008080 } // Name.Variable.Instance - .il { color: #099 } // Literal.Number.Integer.Long -} diff --git a/about.md b/about.md deleted file mode 100644 index 1e36137f..00000000 --- a/about.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -layout: page -title: About -permalink: /about/ ---- - -utPLSQL is a very versatile open source unit testing framework for Oracle PL/SQL. - -It allow for automated testing of: - -* Packages -* Functions -* Procedures -* Anything that can be execute or observed in PL/SQL such as: - * Table Default Values - * Table Triggers - * View Triggers - * Objects - - -utPLSQL was originally developed by [Steven Feuerstein](http://stevenfeuerstein.com/) and is now maintained by active team of developers. - -Feel free to [try it out](/downloads) you won't regret it. Additional information can be found in the [documentation](/documentation) diff --git a/contributing.md b/contributing.md deleted file mode 100644 index 14cbc648..00000000 --- a/contributing.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -layout: page -title: Contributing -permalink: /contributing/ ---- - -utPLSQL project team is always willing to work with the community. - -- Feel free post [bugs or issues](https://github.com/utPLSQL/utPLSQL/issues). We also have discussions in the issues feel to to post questions there. -- Join developers the [utPLSQL team](http://utplsql-slack-invite.herokuapp.com) on [Slack](https://slack.com/) -- Contribute to and learn from the [wiki](https://github.com/utPLSQL/utPLSQL/wiki). -- [Make and submit changes](https://github.com/utPLSQL/utPLSQL/blob/master/CONTRIBUTING.md) to the code base. - -You can find the source code for the utpsql on GitHub: -{% include icon-github.html username="utplsql" %} diff --git a/css/main.scss b/css/main.scss deleted file mode 100644 index 64c8146f..00000000 --- a/css/main.scss +++ /dev/null @@ -1,59 +0,0 @@ ---- -# Only the main Sass file needs front matter (the dashes are enough) ---- -@charset "utf-8"; - - - -// Our variables -$base-font-family: "Helvetica Neue", Helvetica, Arial, sans-serif; -$base-font-size: 16px; -$base-font-weight: 400; -$small-font-size: $base-font-size * 0.875; -$base-line-height: 1.5; - -$spacing-unit: 30px; - -$text-color: #111; -$background-color: #fdfdfd; -$brand-color: #2a7ae2; - -$grey-color: #828282; -$grey-color-light: lighten($grey-color, 40%); -$grey-color-dark: darken($grey-color, 25%); - -$violet-color: #800080; -$white-color: #FFFFFF; - -$header-background: $violet-color; -$header-text: $white-color; - -// Width of the content area -$content-width: 800px; - -$on-palm: 600px; -$on-laptop: 800px; - - - -// Use media queries like this: -// @include media-query($on-palm) { -// .wrapper { -// padding-right: $spacing-unit / 2; -// padding-left: $spacing-unit / 2; -// } -// } -@mixin media-query($device) { - @media screen and (max-width: $device) { - @content; - } -} - - - -// Import partials from `sass_dir` (defaults to `_sass`) -@import - "base", - "layout", - "syntax-highlighting" -; diff --git a/docs/CNAME b/docs/CNAME new file mode 100644 index 00000000..c9c61f1e --- /dev/null +++ b/docs/CNAME @@ -0,0 +1 @@ +www.utplsql.org \ No newline at end of file diff --git a/docs/about.md b/docs/about.md new file mode 100644 index 00000000..e4825024 --- /dev/null +++ b/docs/about.md @@ -0,0 +1,67 @@ +--- +layout: page +title: About +permalink: /about/ +menuInclude: true +--- + +{% + include-markdown "https://raw.githubusercontent.com/utPLSQL/.github/main/profile/README.md" + rewrite-relative-urls=true + start="" + end="" +%} + + +## History + +### Framework history + +While the framework exists since 1999, +the current version is a consequence of a complete rewrite done in 2016 by passionate developers, +using the object-oriented capabilities of the Oracle database to make it more aligned with other testing frameworks (e.g. JUnit for Java, RSpec for Ruby). + +This had significant impact on the test code syntax and how the framework is used. + +In 2026, utPLSQL Development Labs Ltd was established to provide a sustainable legal and financial foundation for the project ([announcement](announcements/posts/2026/2026-09-25_incorporation_of_utPLSQL.md), [background](https://oraclethoughts.com/blog/2026/09/25/incorporation_of_utPLSQL/)). + +Gratitude to creators, contributors and maintainers of previous versions of the framework +- [Steven Feuerstein](https://www.linkedin.com/in/steven-feuerstein/) - Initial Author +- [Chris Rimmer](https://www.linkedin.com/in/chrisrim/) +- [Patrick Barel](https://www.linkedin.com/in/patrickbarel/) +- [Paul Walker](https://www.linkedin.com/in/paul-walker-67b0226b/) +- and others + +### Major Contributors + +| Name | GitHub | Comments | +|-------------------------------------------------------------------------|----------------------------------------------|----------------------------------------------------------------------------------------------------| +| [Jacek Gebal](https://www.linkedin.com/in/jacekgebal/) | [jgebal](https://github.com/jgebal) | Project lead, admin, core PL/SQL framework, pipelines, expectations, reporters, annotations, cache | +| [Pavel Kaplya](https://www.linkedin.com/in/pavel-kaplya/) | [Pazus](https://github.com/Pazus) | Core PL/SQL framework, design, annotations, pipelines | +| [Lukasz Wasylow](https://www.linkedin.com/in/lukasz-wasylow-45a38120/) | [lwasylow](https://github.com/lwasylow/) | Core PL/SQL framework, demo project | +| [Samuel Nitsche](https://www.linkedin.com/in/samuel-nitsche-457ba3158/) | [pesse](https://github.com/pesse/) | utPLSQL-java-api, utPLSQL-cli | +| [Philipp Salvisberg](https://www.linkedin.com/in/philippsalvisberg/) | | utPLSQL-SQLDeveloper-extension | +| [Simon Martinelli](https://www.linkedin.com/in/simonmartinelli/) | | utPLSQL-PLSQL-Developer plugin, utPLSQL-cli | +| [Vinicius Avellar](https://www.linkedin.com/in/amvinicius/) | [viniciusam](https://github.com/viniciusam/) | utPLSQL-java-api, maven-plugin, utPLSQL-cli | +| [Robert Love](https://www.linkedin.com/in/robjlove/) | [rlove](https://github.com/rlove) | | +| [David Pyke](https://www.linkedin.com/in/davidpyke/) | [Shoelace](https://github.com/Shoelace) | | + + +Many thanks to [all contributors](https://github.com/utPLSQL/utPLSQL/graphs/contributors) across utPLSQL projects. + + +## Contact + +For help with using utPLSQL, bug reports and feature ideas, please use [GitHub Discussions](https://github.com/orgs/utPLSQL/discussions). + +- **General questions** - email [info@utPLSQL.org](mailto:info@utPLSQL.org) +- **Inquiries via social media** - [X](https://x.com/utPLSQL), [LinkedIn](https://www.linkedin.com/company/utplsql/), [Bluesky](https://bsky.app/profile/utplsql.org) + +--- +utPLSQL is free open-source software, built by its maintainers and contributors. Sustainable maintenance and development requires funding. + +- Do you want to support the project? +- Is your company looking for commercial support from the project? + +[Become a sponsor](sponsorship.md){ .md-button .md-button--primary } + diff --git a/docs/announcements/index.md b/docs/announcements/index.md new file mode 100644 index 00000000..249c948c --- /dev/null +++ b/docs/announcements/index.md @@ -0,0 +1,3 @@ +# Announcements + +[:material-rss: Subscribe via RSS](/feed_rss_created.xml) diff --git a/_posts/2016-06-20-welcome-to-new-website.md b/docs/announcements/posts/2016/2016-06-20-welcome-to-new-website.md similarity index 90% rename from _posts/2016-06-20-welcome-to-new-website.md rename to docs/announcements/posts/2016/2016-06-20-welcome-to-new-website.md index c588d4c6..cd3ed50d 100644 --- a/_posts/2016-06-20-welcome-to-new-website.md +++ b/docs/announcements/posts/2016/2016-06-20-welcome-to-new-website.md @@ -1,8 +1,10 @@ --- layout: post title: "Welcome to new web site" -date: 2016-06-20 15:00:00 -0600 -categories: moving +date: + created: 2016-06-20 +categories: + - "version2-moving" --- Welcome to the new utPLSQL website. We are still in the early stages of moving to GitHub. diff --git a/_posts/2016-06-24-documentation-now-hosted.md b/docs/announcements/posts/2016/2016-06-24-documentation-now-hosted.md similarity index 86% rename from _posts/2016-06-24-documentation-now-hosted.md rename to docs/announcements/posts/2016/2016-06-24-documentation-now-hosted.md index ac14ecee..d273242b 100644 --- a/_posts/2016-06-24-documentation-now-hosted.md +++ b/docs/announcements/posts/2016/2016-06-24-documentation-now-hosted.md @@ -1,8 +1,10 @@ --- layout: post title: "Documentation is now hosted." -date: 2016-06-24 10:00:00 -0600 -categories: moving +date: + created: 2016-06-24 +categories: + - "version2-moving" --- [Issue #19](https://github.com/utPLSQL/utPLSQL/issues/19) to link documentation to the website has been completed. diff --git a/_posts/2016-07-07-version-2-3-1-released.md b/docs/announcements/posts/2016/2016-07-07-version-2-3-1-released.md similarity index 83% rename from _posts/2016-07-07-version-2-3-1-released.md rename to docs/announcements/posts/2016/2016-07-07-version-2-3-1-released.md index d4fa4ef3..c95098db 100644 --- a/_posts/2016-07-07-version-2-3-1-released.md +++ b/docs/announcements/posts/2016/2016-07-07-version-2-3-1-released.md @@ -1,8 +1,10 @@ --- layout: post title: "Version 2.3.1 has been released." -date: 2016-07-07 10:00:00 -0600 -categories: moving +date: + created: 2016-07-07 +categories: + - "version2-moving" --- [Version 2.3.1](https://github.com/utPLSQL/utPLSQL/releases/tag/utplsql-2-3-1) has been released. diff --git a/_posts/2016-10-10-Version3-pre-alpha.md b/docs/announcements/posts/2016/2016-10-10-Version3-pre-alpha.md similarity index 77% rename from _posts/2016-10-10-Version3-pre-alpha.md rename to docs/announcements/posts/2016/2016-10-10-Version3-pre-alpha.md index 35e2ce9a..78fd3a4c 100644 --- a/_posts/2016-10-10-Version3-pre-alpha.md +++ b/docs/announcements/posts/2016/2016-10-10-Version3-pre-alpha.md @@ -1,8 +1,11 @@ --- layout: post title: "Version 3 - pre-alpha" -date: 2016-10-10 11:00:00 -0600 -categories: version3 +date: + created: 2016-10-10 +categories: + - "releases" + - "utplsql-core" --- Version 3 in pre-alpha state @@ -12,7 +15,5 @@ Nearly every day version 3 has commits to repository with multiple developers co It won't be long until we are in an alpha status. If your interested in following along or helping out with the project check out the [version 3 readme.md](https://github.com/utPLSQL/utPLSQL/blob/version3/readme.md) -Feel free to join us in our [slack chat room](http://utplsql-slack-invite.herokuapp.com/) where we communicate daily about the project. - We welcome support requests and discussions, feature requests, and bug reports in the [GitHub issues log](https://github.com/utPLSQL/utPLSQL/issues). \ No newline at end of file diff --git a/_posts/2017-01-17-Version3.0.0.0-Alpha1.md b/docs/announcements/posts/2017/2017-01-17-Version3.0.0.0-Alpha1.md similarity index 73% rename from _posts/2017-01-17-Version3.0.0.0-Alpha1.md rename to docs/announcements/posts/2017/2017-01-17-Version3.0.0.0-Alpha1.md index 4a236708..743c71f8 100644 --- a/_posts/2017-01-17-Version3.0.0.0-Alpha1.md +++ b/docs/announcements/posts/2017/2017-01-17-Version3.0.0.0-Alpha1.md @@ -1,8 +1,11 @@ --- layout: post title: "Version 3.0.0.0-Alpha1 released" -date: 2017-01-17 18:00:00 -0600 -categories: version3 +date: + created: 2017-01-17 +categories: + - "releases" + - "utplsql-core" --- Version 3 has reached alpha state. @@ -11,7 +14,5 @@ It can be downloaded from the [releases page.](https://github.com/utPLSQL/utPLSQ It's being used now in multiple organizations with great success. The documentation work is progressing. However, we realize that quite a bit of work needs to be done in this area. -Feel free to join us in our [slack chat room](http://utplsql-slack-invite.herokuapp.com/) where we communicate daily about the project. - We welcome support requests and discussions, feature requests, and bug reports in the [GitHub issues log](https://github.com/utPLSQL/utPLSQL/issues). diff --git a/_posts/2017-04-01-Version3Beta1.md b/docs/announcements/posts/2017/2017-04-01-Version3Beta1.md similarity index 75% rename from _posts/2017-04-01-Version3Beta1.md rename to docs/announcements/posts/2017/2017-04-01-Version3Beta1.md index 16f9fe10..3efcdf49 100644 --- a/_posts/2017-04-01-Version3Beta1.md +++ b/docs/announcements/posts/2017/2017-04-01-Version3Beta1.md @@ -1,8 +1,11 @@ --- layout: post title: "Version v3.0.0-beta has been released" -date: 2017-04-01 12:00:00 -0600 -categories: version3 +date: + created: 2017-04-01 +categories: + - "releases" + - "utplsql-core" --- @@ -12,8 +15,6 @@ It can be downloaded from the [releases page.](https://github.com/utPLSQL/utPLSQ It's being used now in multiple organizations with great success. The documentation work is progressing. However, we realize that quite a bit of work needs to be done in this area. -Feel free to join us in our [slack chat room](http://utplsql-slack-invite.herokuapp.com/) where we communicate daily about the project. - We welcome support requests and discussions, feature requests, and bug reports in the [GitHub issues log](https://github.com/utPLSQL/utPLSQL/issues). This is not an April Fools Day Joke, we really release it. diff --git a/_posts/2017-05-18-version3.0.0-released.md b/docs/announcements/posts/2017/2017-05-18-version3.0.0-released.md similarity index 93% rename from _posts/2017-05-18-version3.0.0-released.md rename to docs/announcements/posts/2017/2017-05-18-version3.0.0-released.md index be3bd2bb..4598abea 100644 --- a/_posts/2017-05-18-version3.0.0-released.md +++ b/docs/announcements/posts/2017/2017-05-18-version3.0.0-released.md @@ -1,8 +1,11 @@ --- layout: post title: "utPLSQL v3.0.0 - released!" -date: 2017-05-18 06:52:00 +0000 -categories: version3 +date: + created: 2017-05-18 +categories: + - "releases" + - "utplsql-core" --- diff --git a/_posts/2017-06-14-version3.0.1-released.md b/docs/announcements/posts/2017/2017-06-14-version3.0.1-released.md similarity index 90% rename from _posts/2017-06-14-version3.0.1-released.md rename to docs/announcements/posts/2017/2017-06-14-version3.0.1-released.md index c6dffb77..c21ac6c1 100644 --- a/_posts/2017-06-14-version3.0.1-released.md +++ b/docs/announcements/posts/2017/2017-06-14-version3.0.1-released.md @@ -1,8 +1,12 @@ --- layout: post title: "utPLSQL v3.0.1 - released" -date: 2017-06-14 23:05:00 +0000 -categories: version3 +date: + created: 2017-06-14 +categories: + - "releases" + - "utplsql-core" + --- diff --git a/_posts/2017-07-18-version3.0.2-released.md b/docs/announcements/posts/2017/2017-07-18-version3.0.2-released.md similarity index 95% rename from _posts/2017-07-18-version3.0.2-released.md rename to docs/announcements/posts/2017/2017-07-18-version3.0.2-released.md index 72834bde..d4808a80 100644 --- a/_posts/2017-07-18-version3.0.2-released.md +++ b/docs/announcements/posts/2017/2017-07-18-version3.0.2-released.md @@ -1,8 +1,12 @@ --- layout: post title: "utPLSQL v3.0.2 - released" -date: 2017-07-18 19:45:00 +0000 -categories: version3 +date: + created: 2017-07-18 +categories: + - "releases" + - "utplsql-core" + --- diff --git a/_posts/2017-08-30-version3.0.3-released.md b/docs/announcements/posts/2017/2017-08-30-version3.0.3-released.md similarity index 96% rename from _posts/2017-08-30-version3.0.3-released.md rename to docs/announcements/posts/2017/2017-08-30-version3.0.3-released.md index 69b66b54..48c4b652 100644 --- a/_posts/2017-08-30-version3.0.3-released.md +++ b/docs/announcements/posts/2017/2017-08-30-version3.0.3-released.md @@ -1,8 +1,12 @@ --- layout: post title: "utPLSQL v3.0.3 - released" -date: 2017-08-30 08:35:00 +0000 -categories: version3 +date: + created: 2017-08-30 +categories: + - "releases" + - "utplsql-core" + --- diff --git a/_posts/2017-11-03-version3.0.4-released.md b/docs/announcements/posts/2017/2017-11-03-version3.0.4-released.md similarity index 91% rename from _posts/2017-11-03-version3.0.4-released.md rename to docs/announcements/posts/2017/2017-11-03-version3.0.4-released.md index d2ecf0e0..bb5e1ab8 100644 --- a/_posts/2017-11-03-version3.0.4-released.md +++ b/docs/announcements/posts/2017/2017-11-03-version3.0.4-released.md @@ -1,8 +1,12 @@ --- layout: post title: "utPLSQL v3.0.4 - released" -date: 2017-11-03 11:35:00 +0000 -categories: version3 +date: + created: 2017-11-03 +categories: + - "releases" + - "utplsql-core" + --- diff --git a/_posts/2017-11-23-cli-version3.0.4-released.md b/docs/announcements/posts/2017/2017-11-23-cli-version3.0.4-released.md similarity index 94% rename from _posts/2017-11-23-cli-version3.0.4-released.md rename to docs/announcements/posts/2017/2017-11-23-cli-version3.0.4-released.md index 2c51b858..90e94e4c 100644 --- a/_posts/2017-11-23-cli-version3.0.4-released.md +++ b/docs/announcements/posts/2017/2017-11-23-cli-version3.0.4-released.md @@ -1,8 +1,12 @@ --- layout: post title: "We've released utPLSQL-cli" -date: 2017-11-22 09:04:00 +0000 -categories: version3 +date: + created: 2017-11-22 +categories: + - "releases" + - "utplsql-core" + --- diff --git a/_posts/2018-03-29-cli-version3.1.0-released.md b/docs/announcements/posts/2018/2018-03-29-cli-version3.1.0-released.md similarity index 96% rename from _posts/2018-03-29-cli-version3.1.0-released.md rename to docs/announcements/posts/2018/2018-03-29-cli-version3.1.0-released.md index dceddbec..897f30ce 100644 --- a/_posts/2018-03-29-cli-version3.1.0-released.md +++ b/docs/announcements/posts/2018/2018-03-29-cli-version3.1.0-released.md @@ -1,8 +1,12 @@ --- layout: post title: "utPLSQL-cli v3.1.0 released" -date: 2018-03-29 21:04:00 +0000 -categories: version3 +date: + created: 2018-03-29 +categories: + - "releases" + - "utplsql-core" + --- diff --git a/_posts/2018-07-20-version3.1.1-delayed_announcement.md b/docs/announcements/posts/2018/2018-07-20-version3.1.1-delayed_announcement.md similarity index 98% rename from _posts/2018-07-20-version3.1.1-delayed_announcement.md rename to docs/announcements/posts/2018/2018-07-20-version3.1.1-delayed_announcement.md index aab582a4..d908302e 100644 --- a/_posts/2018-07-20-version3.1.1-delayed_announcement.md +++ b/docs/announcements/posts/2018/2018-07-20-version3.1.1-delayed_announcement.md @@ -1,8 +1,12 @@ --- layout: post title: "Better late than never" -date: 2018-07-20 21:01:00 +0000 -categories: version3 +date: + created: 2018-07-20 +categories: + - "releases" + - "utplsql-core" + --- diff --git a/_posts/2018-07-22-version3.1.2-released.md b/docs/announcements/posts/2018/2018-07-22-version3.1.2-released.md similarity index 97% rename from _posts/2018-07-22-version3.1.2-released.md rename to docs/announcements/posts/2018/2018-07-22-version3.1.2-released.md index fceab083..c1d0ea0d 100644 --- a/_posts/2018-07-22-version3.1.2-released.md +++ b/docs/announcements/posts/2018/2018-07-22-version3.1.2-released.md @@ -1,8 +1,12 @@ --- layout: post title: "utPLSQL v3.1.2 released" -date: 2018-07-21 10:55:00 +0000 -categories: version3 +date: + created: 2018-07-21 +categories: + - "releases" + - "utplsql-core" + --- # Changes in release 3.1.2 diff --git a/docs/announcements/posts/2018/2018-10-24-cli-version3.1.2-released.md b/docs/announcements/posts/2018/2018-10-24-cli-version3.1.2-released.md new file mode 100644 index 00000000..ecc2f7dc --- /dev/null +++ b/docs/announcements/posts/2018/2018-10-24-cli-version3.1.2-released.md @@ -0,0 +1,37 @@ +--- +layout: post +title: "utPLSQL-cli v3.1.2 released" +date: + created: 2018-10-24 +categories: + - "releases" + - "utplsql-cli" +--- + + +# Changes in release 3.1.2 +## Compatibility + +This version of utPLQL-cli is compatible with all versions of utPLSQL from 3.0.0 to 3.1.3. We encourage you to always use the latest version of cli to communicate with a v3 core. + + +## New Features +* New command `utplsql info [user/password@connectstring]` [#77](https://github.com/utPLSQL/utPLSQL-cli/issues/77) +* New command `utplsql reporters user/password@connecstring` +* Cli tries to connect to oracle via thick-driver first and use thin-driver as fallback [#88](https://github.com/utPLSQL/utPLSQL-cli/issues/88) [#90](https://github.com/utPLSQL/utPLSQL-cli/issues/90) [#91](https://github.com/utPLSQL/utPLSQL-cli/issues/91) + +## Enhancements +* Limit number of connections to number of reporters+1 [#85](https://github.com/utPLSQL/utPLSQL-cli/issues/85) +* Include JAXB library so utPLSQL-cli can be run on java 9+10 [#82](https://github.com/utPLSQL/utPLSQL-cli/issues/82) + * There is however still a problem when using HTMLCoverageReporter and Java 9/10 +* Improved documentation and help-command [#31](https://github.com/utPLSQL/utPLSQL-cli/issues/31) +* An existant NLS_LANG-variable will now lead to corresponding `ALTER SESSION` statements when connecting [#101](https://github.com/utPLSQL/utPLSQL-cli/issues/101) + +## Bugfixes +* HTML Coverage assets are placed and referenced correctly when using output file in subdirectory [#94](https://github.com/utPLSQL/utPLSQL-cli/issues/94) +* Java-locale is now correctly derived from LC_ALL or LANG environment variable, not from NLS_LANG [#101](https://github.com/utPLSQL/utPLSQL-cli/issues/101) + +## Internal enhancements +* Refactoring of Command architecture +* Refactoring of Connection handling +* Improved Error handling \ No newline at end of file diff --git a/docs/announcements/posts/2018/2018-11-13-howto-integrate-utplsql-in-visual-studio.md b/docs/announcements/posts/2018/2018-11-13-howto-integrate-utplsql-in-visual-studio.md new file mode 100644 index 00000000..dd6f8c4e --- /dev/null +++ b/docs/announcements/posts/2018/2018-11-13-howto-integrate-utplsql-in-visual-studio.md @@ -0,0 +1,14 @@ +--- +layout: post +title: "How to integrate utPLSQL into Visual Studio" +date: + created: 2018-11-13 +categories: + - "tips-n-tricks" +--- + +How to easily integrate @utPLSQL into @VisualStudio via External Tools. + +[![integrate via external tools](https://user-images.githubusercontent.com/8362976/48398860-48bc3b80-e722-11e8-9537-2ee9ee4d156d.png "Integrate via External Tools")](https://user-images.githubusercontent.com/8362976/48398860-48bc3b80-e722-11e8-9537-2ee9ee4d156d.png) + +[Tweet by Der_Pesse](https://twitter.com/Der_Pesse/status/1062255580805500933) diff --git a/docs/announcements/posts/2018/2018-11-20-version3.1.3-released.md b/docs/announcements/posts/2018/2018-11-20-version3.1.3-released.md new file mode 100644 index 00000000..2a1ceecd --- /dev/null +++ b/docs/announcements/posts/2018/2018-11-20-version3.1.3-released.md @@ -0,0 +1,43 @@ +--- +layout: post +title: "utPLSQL v3.1.3 released" +date: + created: 2018-11-20 +categories: + - "releases" + - "utplsql-core" + +--- + +# Changes in release 3.1.3 + +## New features + +- added function `ut_runner.is_test` #788 +- added function `ut_runner.is_suite` #787 +- added function `ut_runner.has_suites` #786 +- added ability to disable automatic rollback for a test-run #784 +- when invoked with package name, utPLSQL will now run only tests from specified package even if package has child packages by suitepath #776 + +## Enhancements + +- Improved performance of schema-scanning and utPLSQL startup #778 +- Improved performance of output-buffer #777 +- Improved documentation to mention ability to pass client encoding for HTML & XML reports #775 +- Improved documentation for cursor comparison to mention challenges with TIMESTAMP bind variables + +## Bug-fixes + +- utPLSQL code coverage will now work properly with long object names #716 +- utPLSQL installation will now also work properly, when user performing the install has `ANY` grants #737 +- fixed documentation bug for `--%context` with `--%displayname` #726 +- fixed Teamcity reporter issues with missing escape for some characters and long messages #747 +- fixed issue with sonar test results reporter when contexts are used #749 +- fixed issue with ORA-07455 getting thrown on cursor comparison #752 +- fixed issue with wrong failure message for unordered data #764 +- fixed missing privilege issue for unordered/join-by cursor data comparison #765 #770 + + +## Internal enhancements + +- added suite-level cache to allow for faster retrieval of suite contents and enable implementation of additional features #783 diff --git a/docs/announcements/posts/2019/2019-03-19-version3.1.4-released.md b/docs/announcements/posts/2019/2019-03-19-version3.1.4-released.md new file mode 100644 index 00000000..c704d75b --- /dev/null +++ b/docs/announcements/posts/2019/2019-03-19-version3.1.4-released.md @@ -0,0 +1,52 @@ +--- +layout: post +title: "utPLSQL v3.1.4 released" +date: + created: 2019-03-19 +categories: + - "releases" + - "utplsql-core" + +--- + +# Changes in release 3.1.4 + +## New features + +- Added `to_contain` matcher for collections and cursors [#79](https://github.com/utPLSQL/utPLSQL/issues/79) +- Added `unordered_columns` (`uc`) option for cursor comparison to ignore the order of the columns [#779](https://github.com/utPLSQL/utPLSQL/issues/779) +- Added `ut_debug_reporter` for debug logging [#480](https://github.com/utPLSQL/utPLSQL/issues/480) +- Added `ut_realtime_reporter` for utPLSQL-SQLDeveloper extension [#795](https://github.com/utPLSQL/utPLSQL/issues/795) + +## Enhancements + +- Improved performance of cursor comparison [#780](https://github.com/utPLSQL/utPLSQL/issues/780) +- Added support for installation on databases with block size < 8KB [#848](https://github.com/utPLSQL/utPLSQL/issues/848) +- Added initial timeout to `ut_output_buffer` [#840](https://github.com/utPLSQL/utPLSQL/issues/840) +- Enhanced performance of `get_reporters_list` function [#814](https://github.com/utPLSQL/utPLSQL/issues/814) +- Moved calls of `dbms_lock.sleep` to `dbms_session` for newer DB versions [#806](https://github.com/utPLSQL/utPLSQL/issues/806) +- utPLSQL coverage will now work without re-install after DB-upgrade from 12.1 to 12.2 [#803](https://github.com/utPLSQL/utPLSQL/issues/803) + +## Bug fixes + +- Fixed problem with REGEXP in annotation parsing with NLS CANADIAN FRENCH [#844](https://github.com/utPLSQL/utPLSQL/issues/844) +- Fixed issue with Rollback to savepoint failing on distributed transaction [#839](https://github.com/utPLSQL/utPLSQL/issues/839) +- Fixed reporting of differences when comparing collections scalar values [#835](https://github.com/utPLSQL/utPLSQL/issues/835) +- Fixed issue with test run failing due to too many transaction invalidators [#834](https://github.com/utPLSQL/utPLSQL/issues/834) +- Fixed randomly occurring error during cursor comparison [#827](https://github.com/utPLSQL/utPLSQL/issues/827) +- utPLSQL install script will now support special characters in passwords [#804](https://github.com/utPLSQL/utPLSQL/issues/804) + +## Documentation improvements + +- Fixed documentation examples for context annotation [#851](https://github.com/utPLSQL/utPLSQL/issues/851) +- Added description on how to check version of utPLSQL [#822](https://github.com/utPLSQL/utPLSQL/issues/822) + +## Internal enhancements + +- Implemented Sonar analysis on DBA Views [#850](https://github.com/utPLSQL/utPLSQL/issues/850) +- Finished migration from old-tests [#475](https://github.com/utPLSQL/utPLSQL/issues/475) +- Fixed shell scripts to support multiple unix dialects (especially for macOS) [#796](https://github.com/utPLSQL/utPLSQL/issues/796) +- Added info on project support from Redgate [#841](https://github.com/utPLSQL/utPLSQL/issues/841) +- Added `code_of_conduct` [#836](https://github.com/utPLSQL/utPLSQL/issues/836) +- Added issue tempates [#842](https://github.com/utPLSQL/utPLSQL/issues/842) +- Added utPLSQL logo [#845](https://github.com/utPLSQL/utPLSQL/issues/845) diff --git a/docs/announcements/posts/2019/2019-03-20-version3.1.5-released.md b/docs/announcements/posts/2019/2019-03-20-version3.1.5-released.md new file mode 100644 index 00000000..c7a47e3e --- /dev/null +++ b/docs/announcements/posts/2019/2019-03-20-version3.1.5-released.md @@ -0,0 +1,16 @@ +--- +layout: post +title: "utPLSQL v3.1.5 released" +date: + created: 2019-03-20 +categories: + - "releases" + - "utplsql-core" + +--- + +# Bugfix release for `v3.1.4` + +## Bug fixes + +- Fixed a bug in release `3.1.4` where `to_be_empty` matcher was failing due to privileges [#864](https://github.com/utPLSQL/utPLSQL/issues/864) diff --git a/docs/announcements/posts/2019/2019-03-24-version3.1.6-released.md b/docs/announcements/posts/2019/2019-03-24-version3.1.6-released.md new file mode 100644 index 00000000..2c0d7362 --- /dev/null +++ b/docs/announcements/posts/2019/2019-03-24-version3.1.6-released.md @@ -0,0 +1,19 @@ +--- +layout: post +title: "utPLSQL v3.1.6 released" +date: + created: 2019-03-24 +categories: + - "releases" + - "utplsql-core" + +--- + +# Bugfix release for `v3.1.5` + +## Bug fixes + +- Fixed a bug in release `3.1.5` where `to_equal` matcher was failing due to privileges when comparing non sql diffable types #870 + +## Improvements +- Reduced number of information displaying about user defined type. We will now display only type name instead of full structure #866 \ No newline at end of file diff --git a/docs/announcements/posts/2019/2019-03-25-cli-version3.1.6-released.md b/docs/announcements/posts/2019/2019-03-25-cli-version3.1.6-released.md new file mode 100644 index 00000000..e9548cf8 --- /dev/null +++ b/docs/announcements/posts/2019/2019-03-25-cli-version3.1.6-released.md @@ -0,0 +1,38 @@ +--- +layout: post +title: "utPLSQL-cli v3.1.6 released" +date: + created: 2019-03-25 +categories: + - "releases" + - "utplsql-cli" +--- + + +# Changes in release 3.1.6 + +## Compatibility +This version of utPLQL-cli is compatible with all versions of utPLSQL from 3.0.0 to 3.1.6. We encourage you to always use the latest version of cli to communicate with a v3 core. + +## New Features +* CLI now logs some basic information to screen in addition to an eventually configured to-screen-reporter ([#89](https://github.com/utPLSQL/utPLSQL-cli/issues/89), [#76](https://github.com/utPLSQL/utPLSQL-cli/issues/76)) + * This output can be avoided with the new `-q, --quiet` parameter + * Much more logging can be output with the new `-d, --debug` parameter +* It's possible to connect as sysdba now via `utplsql run "sys as sysdba"/pw@connectstring` ([#115](https://github.com/utPLSQL/utPLSQL-cli/issues/115)) +* The default timeout of 60 minutes is now configurable via the new `-t, --timeout` parameter ([#124](https://github.com/utPLSQL/utPLSQL-cli/issues/124)) + +## Enhancements +* Timeout now returns error exit-code ([#129](https://github.com/utPLSQL/utPLSQL-cli/issues/129)) +* In case of Oracle stuck-scenario during createStatement, a warning is written to the screen and the same call for running the tests is retried up to 5 times. ([#20](https://github.com/utPLSQL/utPLSQL-cli/issues/20)) +* It's now possible to pass usernames containing `/` and passwords containing `@` by encapsulating those in the connectstring with `"`: `utplsql run "my/User"/"P@ssword"@server:1521/Service` ([#111](https://github.com/utPLSQL/utPLSQL-cli/issues/111)) +* API-version is now stored in a separate, non-compiled file + +## Bugfixes +* Info command should now show the correct version information ([#108](https://github.com/utPLSQL/utPLSQL-cli/issues/108)) +* Non-argument call will output help ([#110](https://github.com/utPLSQL/utPLSQL-cli/issues/110)) + +## Internal enhancements +* Update of HikariCP +* Improvement of passing user/pw/connect info to connection pool +* Improvement of Error-Handling +* Cleanup of tests \ No newline at end of file diff --git a/docs/announcements/posts/2019/2019-04-28-utPLSQL-tested-with-5-DB-version.md b/docs/announcements/posts/2019/2019-04-28-utPLSQL-tested-with-5-DB-version.md new file mode 100644 index 00000000..1f61eff8 --- /dev/null +++ b/docs/announcements/posts/2019/2019-04-28-utPLSQL-tested-with-5-DB-version.md @@ -0,0 +1,41 @@ +--- +layout: post +title: "utPLSQL is continuously tested on 5 DB versions" +date: + created: 2019-04-28 +categories: + - "news" +--- + +# Oracle 19c DB added to our CI/CD process + +We take all the possible effort to assure utPLSQL can be tested against t all supported Oracle database versions. + +Today, our automation got enriched with Oracle 19c database testing. + +Pavel Kaplya has prepared a new **small Docker Image** for Oracle 19c. + +**Note:** +> You can take advantage of our efforts and build your own small Docker images (non-PDB) using our [docker-scripts](https://github.com/utPLSQL/docker-scripts). + +# Continuous testing of utPLSQL + +utPLSQL is now getting tested against *five* database versions: +- Oracle 11g XE +- Oracle 12c R1 +- Oracle 12c R2 +- Oracle 18c +- Oracle 19c + +You can see our build process & test results on [travis-ci.org/utPLSQL](https://travis-ci.org/utPLSQL) + +All of our deliverable projects use set of tools that are free to sue for Open-Source: +- static code analysis using [sonarcloud](https://sonarcloud.io/organizations/utplsql/projects) +- publishing code coverage using [coveralls](https://coveralls.io/github/utPLSQL/utPLSQL) +- deploying java-api artifacts to [packagecloud](https://packagecloud.io/utPLSQL/utPLSQL-java-api) +- deploying utPLSQL-cli artifacts to [bintray](https://bintray.com/utplsql/utPLSQL-cli/utPLSQL-cli-develop) +- maven plugin publishing into [maven repository](https://mvnrepository.com/artifact/org.utplsql/utplsql-maven-plugin) + +All of our builds must pass quality gates (code quality/tests/code coverage) before we approve and merge pull requests. + + diff --git a/docs/announcements/posts/2019/2019-05-09-sqlcl-integration-for-utPLSQL.md b/docs/announcements/posts/2019/2019-05-09-sqlcl-integration-for-utPLSQL.md new file mode 100644 index 00000000..cb0e4be8 --- /dev/null +++ b/docs/announcements/posts/2019/2019-05-09-sqlcl-integration-for-utPLSQL.md @@ -0,0 +1,27 @@ +--- +layout: post +title: "Auto-run utPLSQL tests with Oracle sqlcl" +date: + created: 2019-05-09 +categories: + - "tips-n-tricks" +--- + +Today at [#apexConn19](https://twitter.com/search?q=%23apexConn19&src=typd). + +[Sam Nitsche](https://twitter.com/Der_Pesse) (blogger, presenter, testing & compassionate-coding advocate, utPLSQL-cli & utPLSQL-api developer) met with [Kris Rice](https://twitter.com/krisrice) (Oracle SQLDeveloper, sqlcl, ORDS rock-star, developer, advocate, presenter, mentor) + +As a result, something amazing happened. Within an hour or so, Kris created a fully functional auto-runner for utPLSQL tests within Oracle sqlcl. + + +![utPSLQL-sqlcl](../../../assets/sqlcl-utplsql.jpg) + +[See for yourself](https://twitter.com/krisrice/status/1126467712211988480) + +If you want to use sqlcl to run your tests, each time you compile a package, have a look at [this script](https://github.com/krisrice/sqlcl-utplsql) for sqlcl. + + +**Huge thank you to Kris and Sam!** + +>*Amazing things can happen when right people meet at right time in right place.* + diff --git a/docs/announcements/posts/2019/2019-06-18-version3.1.7-released.md b/docs/announcements/posts/2019/2019-06-18-version3.1.7-released.md new file mode 100644 index 00000000..352ef503 --- /dev/null +++ b/docs/announcements/posts/2019/2019-06-18-version3.1.7-released.md @@ -0,0 +1,53 @@ +--- +layout: post +title: "utPLSQL v3.1.7 released" +date: + created: 2019-06-18 +categories: + - "releases" + - "utplsql-core" + +--- + +- # Changes in release 3.1.7 + + ## New features + + - Added support for [comparing `json`](https://github.com/utPLSQL/utPLSQL/blob/v3.1.7/docs/userguide/expectations.md#comparing-json-objects) in Oracle 12.2 and above [#924](https://github.com/utPLSQL/utPLSQL/issues/924) + - Introduced [`tag` annotation](https://github.com/utPLSQL/utPLSQL/blob/v3.1.7/docs/userguide/annotations.md#tags) to enable tagging of tests and suites [#66](https://github.com/utPLSQL/utPLSQL/issues/66) + - Added support for [random order](https://github.com/utPLSQL/utPLSQL/blob/v3.1.7/docs/userguide/running-unit-tests.md#random-order) of test execution [#422](https://github.com/utPLSQL/utPLSQL/issues/422) + + ## Enhancements + + - Added optional [install with DDL trigger](https://github.com/utPLSQL/utPLSQL/blob/v3.1.7/docs/userguide/install.md#installation-with-ddl-trigger) to speed up framework start [#901](https://github.com/utPLSQL/utPLSQL/issues/901) + - Removed dependency on `dbms_utility.name_resolve` [#569](https://github.com/utPLSQL/utPLSQL/issues/569) [#885](https://github.com/utPLSQL/utPLSQL/issues/885) + - New output buffer table structures improving performance and addressing timeout issues [#915](https://github.com/utPLSQL/utPLSQL/issues/915) + + ## Bug fixes + + - Fixed `ut_realtime_reporter` missing warnings in test and suite output structures [#936](https://github.com/utPLSQL/utPLSQL/issues/936) + - Fixed output_buffer purging error [#934](https://github.com/utPLSQL/utPLSQL/issues/934) + - Fixed `join_by / exclude / include` invalid syntax on collection in anydata compare [#912](https://github.com/utPLSQL/utPLSQL/issues/912) + - Fixed `ut_junit_reporter` producing invalid output on failing tests with long failure message [#927](https://github.com/utPLSQL/utPLSQL/issues/927) + - Fixed `ut_sonar_test_reporter` producing invalid output on failing tests with long failure message [#925](https://github.com/utPLSQL/utPLSQL/issues/925) + - Fixed `ut_coverage_cobertura_reporter` producing wrong line breaks which breaks the xml validation against DTD [#917](https://github.com/utPLSQL/utPLSQL/issues/917) + - Fixed `exclude` option for ref cursor where column order was not resolved correctly [#911](https://github.com/utPLSQL/utPLSQL/issues/911) + - Fixed `unordered` option for ref cursor with null values [#914](https://github.com/utPLSQL/utPLSQL/issues/914) + - Fixed number precision when selecting from dual [#907](https://github.com/utPLSQL/utPLSQL/issues/907) + - Fixed ref cursor errors with generated column names [#902](https://github.com/utPLSQL/utPLSQL/issues/902) + - Fixed `ORA-00907` when comparing ref cursors with BINARY_ columns [#899](https://github.com/utPLSQL/utPLSQL/issues/899) + - Fixed wrong results when comparing CLOBs with `to_be_like` in Oracle Database 11.2.0.4 due to Oracle Bug 14402514 [#891](https://github.com/utPLSQL/utPLSQL/issues/891) + - Fixed performance issue with code coverage report on huge PL/SQL code base [#882](https://github.com/utPLSQL/utPLSQL/issues/882) + + ## Documentation improvements + + - Added install instructions for DDL trigger [#874](https://github.com/utPLSQL/utPLSQL/issues/874) + + ## Internal enhancements + + - Fixed SQL vulnerability on all input parameters used in dynamic SQL and PL/SQL [#921](https://github.com/utPLSQL/utPLSQL/issues/921) + - Fixed message id in output buffer [#916](https://github.com/utPLSQL/utPLSQL/issues/916) + - Included 19c database in self testing [#909](https://github.com/utPLSQL/utPLSQL/issues/909) + - Introduced testing with multiple schemas and different grants [#893](https://github.com/utPLSQL/utPLSQL/issues/893) + - Fixed installation script warnings [#879](https://github.com/utPLSQL/utPLSQL/issues/879) + diff --git a/docs/announcements/posts/2019/2019-07-12-cli-version3.1.7-released.md b/docs/announcements/posts/2019/2019-07-12-cli-version3.1.7-released.md new file mode 100644 index 00000000..7f009315 --- /dev/null +++ b/docs/announcements/posts/2019/2019-07-12-cli-version3.1.7-released.md @@ -0,0 +1,31 @@ +--- +layout: post +title: "utPLSQL-cli v3.1.7 released" +date: + created: 2019-07-12T15:00:00 +categories: + - "releases" + - "utplsql-cli" +--- + + +# Changes in release 3.1.7 + +## New Features +* CLI is now runnable from Java 8-12 (and probably also upcoming versions) +* CLI now uses Picocli instead of JCommander. __This might have some impact on how parameters are interpreted__, for example on windows machines when you define `-f=ut_documentation_reporter -o="output.txt"` you will have to enclose the "output.txt" part as shown +* Support for [Tags](https://github.com/utPLSQL/utPLSQL/blob/v3.1.7/docs/userguide/annotations.md#tags) via `--tags=tag1[,tag2[,tag3]]`parameter ([#157](https://github.com/utPLSQL/utPLSQL-cli/issues/157)) +* Support for [random order](https://github.com/utPLSQL/utPLSQL/blob/v3.1.7/docs/userguide/running-unit-tests.md#random-order) of test execution via `-r`/`--random-test-order` and `-seed`/`--random-test-order-seed` ([#139](https://github.com/utPLSQL/utPLSQL-cli/issues/139)) +* Ability to enable DBMS_OUTPUT from cli via `-D`/`--dbms_output` ([#137](https://github.com/utPLSQL/utPLSQL-cli/issues/137)) + +## Enhancements +* Completely removed HikariCP ([#158](https://github.com/utPLSQL/utPLSQL-cli/issues/158)) +* A warning is shown if `orai18n.jar` is not on the classpath. This is highly recommended due to some strange behaviour of the jdbc-driver otherwise ([#146](https://github.com/utPLSQL/utPLSQL-cli/issues/146), [#153](https://github.com/utPLSQL/utPLSQL-cli/issues/153)) + +## Bugfixes +* Type mapping (`-type_mapping`) parameter is now interpreted correctly ([#143](https://github.com/utPLSQL/utPLSQL-cli/issues/143)) + +## Internal enhancements +* Improvement of tests +* Refactoring towards immutability +* Added some more debug information \ No newline at end of file diff --git a/docs/announcements/posts/2019/2019-07-12-java-api-version3.1.7-released.md b/docs/announcements/posts/2019/2019-07-12-java-api-version3.1.7-released.md new file mode 100644 index 00000000..67e1c599 --- /dev/null +++ b/docs/announcements/posts/2019/2019-07-12-java-api-version3.1.7-released.md @@ -0,0 +1,47 @@ +--- +layout: post +title: "utPLSQL-java-api v3.1.7 released" +date: + created: 2019-07-12T09:00:00 +categories: + - "releases" + - "utplsql-java-api" +--- + + +# Changes in release 3.1.7 +## Highlights + +* utPLSQL java-api now supports JDK 8-12 +* Support to call [Tags](https://github.com/utPLSQL/utPLSQL/blob/v3.1.7/docs/userguide/annotations.md#tags) +* Support for [random order](https://github.com/utPLSQL/utPLSQL/blob/v3.1.7/docs/userguide/running-unit-tests.md#random-order) of test execution + +## Changes in public API + +* `CompatibilityProxy` + * It's possible to instantiate it with an optional `assumedUtPlsql` version. This replaces the former `skipCompatibilityCheck` parameter + * Method `getDatabaseVersion` is now deprecated in favor of `getUtPlsqlVersion` and `getRealDbPlsqlVersion` +* `TestRunner` + * `getOptions` returns the current `TestRunnerOptions` now + +## Internal changes +* Added several new tests +* Several small refactorings +* Additional logging +* Preparations to completely rewrite the api + +# Download +https://packagecloud.io/utPLSQL/utPLSQL-java-api/packages/java/org.utplsql/java-api-3.1.7.jar + +## Maven +``` + + org.utplsql + java-api + 3.1.7 + +``` +## Gradle +``` +compile 'org.utplsql:java-api:3.1.7' +``` \ No newline at end of file diff --git a/docs/announcements/posts/2019/2019-08-01-resources-section.md b/docs/announcements/posts/2019/2019-08-01-resources-section.md new file mode 100644 index 00000000..85179a5c --- /dev/null +++ b/docs/announcements/posts/2019/2019-08-01-resources-section.md @@ -0,0 +1,18 @@ +--- +layout: post +title: "New Resources section" +date: + created: 2019-09-04 +categories: + - "website" +--- + +# New Resources section + +We just added a new section to our website: [Resources](/resources). + +We will keep adding all kinds of examples, tutorials, videos, blog posts and other stuff related to +utPLSQL to this page, but we might not know everything. + +So please, if you find something related to utPLSQL which is publicly (without a paywall) available or if you created something +yourself, __please let us know!__ diff --git a/docs/announcements/posts/2019/2019-09-04-version3.1.8-released.md b/docs/announcements/posts/2019/2019-09-04-version3.1.8-released.md new file mode 100644 index 00000000..5b2e8d93 --- /dev/null +++ b/docs/announcements/posts/2019/2019-09-04-version3.1.8-released.md @@ -0,0 +1,35 @@ +--- +layout: post +title: "utPLSQL v3.1.8 released" +date: + created: 2019-09-04 +categories: + - "releases" + - "utplsql-core" + +--- + +# Changes in release 3.1.8 + +[Download from GitHub](https://github.com/utPLSQL/utPLSQL/releases/tag/v3.1.8) + +## New features + +- Added support for [session context](https://github.com/utPLSQL/utPLSQL/blob/v3.1.8/docs/userguide/annotations.md#sys_context) to provide test and suite information during test run [#963](https://github.com/utPLSQL/utPLSQL/issues/963) [#781](https://github.com/utPLSQL/utPLSQL/issues/781) +- Added ability to [invoke expectations without running framework](https://github.com/utPLSQL/utPLSQL/blob/v3.1.8/docs/userguide/expectations.md#running-expectations-outside-utplsql-framework) [#956](https://github.com/utPLSQL/utPLSQL/issues/956) [#963](https://github.com/utPLSQL/utPLSQL/issues/963) +- Failing expectations are now reported with call stack [#967](https://github.com/utPLSQL/utPLSQL/issues/967) [#963](https://github.com/utPLSQL/utPLSQL/issues/963) + +## Enhancements + +- Improved framework table private data protection [#922](https://github.com/utPLSQL/utPLSQL/issues/922) [#954](https://github.com/utPLSQL/utPLSQL/issues/954) +- Improved install process. It is now unified for installation with both public and private synonyms [#957](https://github.com/utPLSQL/utPLSQL/issues/957) [#954](https://github.com/utPLSQL/utPLSQL/issues/954) +- Improved reporting of warnings for integration with SQLDeveloper [#964](https://github.com/utPLSQL/utPLSQL/issues/964) +- Improved query to retrieve coverage sources [#981](https://github.com/utPLSQL/utPLSQL/issues/981) [#970](https://github.com/utPLSQL/utPLSQL/issues/970) +- Improved security around malicious utPLSQL owner name [#920](https://github.com/utPLSQL/utPLSQL/issues/920) + +## Bug fixes + +- Fixed cursor comparison on Oracle 11.2 [#947](https://github.com/utPLSQL/utPLSQL/issues/947) +- Fixed issue with retrieving suite data [#977](https://github.com/utPLSQL/utPLSQL/issues/977) [#974](https://github.com/utPLSQL/utPLSQL/issues/974) [#978](https://github.com/utPLSQL/utPLSQL/issues/978) +- Application context is now reset in session after test run [#951](https://github.com/utPLSQL/utPLSQL/issues/951) + diff --git a/docs/announcements/posts/2019/2019-11-10-version3.1.9-released.md b/docs/announcements/posts/2019/2019-11-10-version3.1.9-released.md new file mode 100644 index 00000000..fb58e9e9 --- /dev/null +++ b/docs/announcements/posts/2019/2019-11-10-version3.1.9-released.md @@ -0,0 +1,46 @@ +--- +layout: post +title: "utPLSQL v3.1.9 released" +date: + created: 2019-11-10 +categories: + - "releases" + - "utplsql-core" + +--- + +# Changes in release 3.1.9 + +## New features + +- Added ability to define [nested contexts](https://github.com/utPLSQL/utPLSQL/blob/v3.1.9/docs/userguide/annotations.md#context) within test suite [#938](https://github.com/utPLSQL/utPLSQL/issues/938) +- Added ability to [exclude tests/suites by tags](https://github.com/utPLSQL/utPLSQL/blob/v3.1.9/docs/userguide/annotations.md#excluding-testssuites-by-tags) when invoking a test-run [#1007](https://github.com/utPLSQL/utPLSQL/issues/1007) [#983](https://github.com/utPLSQL/utPLSQL/issues/983) +- Added new annotation [`--%name`](https://github.com/utPLSQL/utPLSQL/blob/v3.1.9/docs/userguide/annotations.md#name) to allow for providing custom name for contexts [#1016](https://github.com/utPLSQL/utPLSQL/issues/1016) + +## Important changes + +The value of `--%context` annotation is no longer representing context `name`. +This value is now context description (displayname). +With this change, the `--%context` annotation is now aligned with `--%test` and `--%suite` annotation syntax. + +New annotation `--%name` was introduced to facilitate naming of contexts. + + +## Enhancements + +- Improved documentation for running tests +- Improved documentation for tags [#1003](https://github.com/utPLSQL/utPLSQL/issues/1003) +- Improved documentation for annotations + +## Bug fixes + +- Fixed bug with bad stacktrace showing in failing/erroring test [#1000](https://github.com/utPLSQL/utPLSQL/issues/1000) +- Fixed issue with lack of validation for context name [#966](https://github.com/utPLSQL/utPLSQL/issues/966) +- Fixed problem with install script privilege check for installation with DDL trigger [#992](https://github.com/utPLSQL/utPLSQL/issues/992) +- Fixed issue with some common column names causing cursor comparison to fail [#997](https://github.com/utPLSQL/utPLSQL/issues/997) +- Fixed issue with invocation of standalone expectations on cursor [#998](https://github.com/utPLSQL/utPLSQL/issues/998) + +## Internal improvements + +- Fixed runability of utplsql self-tests [#968](https://github.com/utPLSQL/utPLSQL/issues/968) + diff --git a/docs/announcements/posts/2020/2020-02-23-version3.1.10-released.md b/docs/announcements/posts/2020/2020-02-23-version3.1.10-released.md new file mode 100644 index 00000000..b337d780 --- /dev/null +++ b/docs/announcements/posts/2020/2020-02-23-version3.1.10-released.md @@ -0,0 +1,35 @@ +--- +layout: post +title: "utPLSQL v3.1.10 released" +date: + created: 2020-02-23 +categories: + - "releases" + - "utplsql-core" + +--- + +# Changes in release 3.1.10 + + +## Enhancements + +- utPLSQL test runner is now validating arguments of `--%throws` annotations at runtime [#721](https://github.com/utPLSQL/utPLSQL/issues/721) [#1033](https://github.com/utPLSQL/utPLSQL/issues/1033) +- Documented limitations of insignificant spaces comparison in compound data [#880](https://github.com/utPLSQL/utPLSQL/issues/880) +- utPLSQL will now detect empty annotation cache for schema even with DLL trigger enabled [#975](https://github.com/utPLSQL/utPLSQL/issues/975) +- Order of procedures and annotation now determines default order of tests in suite [#1036](https://github.com/utPLSQL/utPLSQL/issues/1036) + + +## Bug fixes + +- Nested contexts are now properly identified [#1034](https://github.com/utPLSQL/utPLSQL/issues/1034) +- TeamCity test reporter is now including error message [#1045](https://github.com/utPLSQL/utPLSQL/issues/1045) + +## Internal improvements + +- All self-tests for utPLSQL framework can now be executed using test-owner schema [#969](https://github.com/utPLSQL/utPLSQL/issues/969) +- Misleading rollback warning is no longer showing when running self-tests for utPLSQL [#982](https://github.com/utPLSQL/utPLSQL/issues/982) + +# Downloads + +Download `v3.1.10` release version [here](https://github.com/utPLSQL/utPLSQL/releases/tag/v3.1.10) \ No newline at end of file diff --git a/docs/announcements/posts/2021/2021-01-01-PLSQL-Developer-plugin-version-1.0.0-released.md b/docs/announcements/posts/2021/2021-01-01-PLSQL-Developer-plugin-version-1.0.0-released.md new file mode 100644 index 00000000..100ee46d --- /dev/null +++ b/docs/announcements/posts/2021/2021-01-01-PLSQL-Developer-plugin-version-1.0.0-released.md @@ -0,0 +1,30 @@ +--- +layout: post +title: "PL/SQL Developer plugin version 1.0.0 released" +date: + created: 2021-01-01 +categories: + - "releases" + - "utplsql-plsql-developer-plugins" +--- + +# PL/SQL Developer plugin released! + + +Happy new year! Thanks to [Simon Martinelli](https://github.com/simasch) utPLSQL v3+ is now integrated with [PL/SQL Developer](https://www.allroundautomations.com/products/pl-sql-developer/) IDE + + +## Features + +- The Plugin enables PL/SQL Developer to run tests and code coverage with utPLSQL +- Tests and code coverage can be run for the current user from the tool ribbon or from the context menu on a package or a user +- Test results shown in a test runner window and the code coverage report will be opened in the default browser + +## Documentation + +See details of plugin usage in [readme file](https://github.com/utPLSQL/utPLSQL-PLSQL-Developer/blob/develop/README.md) + +## Downloads + +- Download the plugin release from [releases page](https://github.com/utPLSQL/utPLSQL-PLSQL-Developer/releases) +- Copy `PlsqlDeveloperUtPlsqlPlugin.dll` or `PlsqlDeveloperUtPlsqlPlugin_x86.dll` to the PlugIns directory of your PL/SQL Developer installation diff --git a/docs/announcements/posts/2021/2021-11-18-version3.1.11-released.md b/docs/announcements/posts/2021/2021-11-18-version3.1.11-released.md new file mode 100644 index 00000000..36fdf0ad --- /dev/null +++ b/docs/announcements/posts/2021/2021-11-18-version3.1.11-released.md @@ -0,0 +1,48 @@ +--- +layout: post +title: "utPLSQL v3.1.11 released" +date: + created: 2021-11-18 +categories: + - "releases" + - "utplsql-core" + +--- + +# Changes in release 3.1.11 + + +## Enhancements + +- utPLSQL can now be used to generate coverage reports for external tools. See [documentation](https://github.com/utPLSQL/utPLSQL/blob/955de5c2dc527a98a6f5dc0dd8bd8d81a44c459f/docs/userguide/coverage.md#reporting-coverage-outside-of-utplsql) + Implemented in: [#1079](https://github.com/utPLSQL/utPLSQL/pull/1079), resolves [#1025](https://github.com/utPLSQL/utPLSQL/issues/1025) +- Enhanced UT_COVERAGE_COBERTURA_REPORTER to better support TFS and GitLab. Implemented in [#1137](https://github.com/utPLSQL/utPLSQL/pull/1137) and [#1140](https://github.com/utPLSQL/utPLSQL/pull/1140), resolves [#1107](https://github.com/utPLSQL/utPLSQL/issues/1107) +- Added support for installation on Oracle 21c - removed dependency on DBMS_OBFUSCATION_TOOLKIT. Implemented in [#1112](https://github.com/utPLSQL/utPLSQL/pull/1112), resolves [#1111](https://github.com/utPLSQL/utPLSQL/issues/1111) and [#1127](https://github.com/utPLSQL/utPLSQL/issues/1127) +- Added support for running utPLSQL framework in parallel-enabled database. Implemented in [#1160](https://github.com/utPLSQL/utPLSQL/pull/1160), resolves [#1134](https://github.com/utPLSQL/utPLSQL/issues/1134) + + + +## Bug fixes + +- Suite structure is built properly even with other than English TNS settings. Implemented in [#1061](https://github.com/utPLSQL/utPLSQL/pull/1061), resolves [#1060](https://github.com/utPLSQL/utPLSQL/issues/1060) +- Fixed XML content reporting (CDATA) in UT_REALTIME_REPORTER used by SQLDeveloper plugin. Implemented in [#1075](https://github.com/utPLSQL/utPLSQL/pull/1075), resolves [#1073](https://github.com/utPLSQL/utPLSQL/issues/1073) +- Fixed XML content reporting (CDATA) in JUnit reporter - regression. Implemented in [#1085](https://github.com/utPLSQL/utPLSQL/pull/1085), resolves [#1084](https://github.com/utPLSQL/utPLSQL/issues/1084) +- Fixed issue with utPLSQL failing to run coverage reporting when trigger has overlapping name with procedure/function/package/type. Implemented in [#1091](https://github.com/utPLSQL/utPLSQL/pull/1091), resolves [#1086](https://github.com/utPLSQL/utPLSQL/issues/1086) +- Fixed issue with parsing utPLSQL suites with DDL trigger when usign AUTHID clause. Implemented in [#1093](https://github.com/utPLSQL/utPLSQL/pull/1093), resolves [#1088](https://github.com/utPLSQL/utPLSQL/issues/1088) + + +## Internal improvements + +- Improved how privilege checks are handled by framework installation. Implemented in [#1056](https://github.com/utPLSQL/utPLSQL/pull/1056), resolves [#1050](https://github.com/utPLSQL/utPLSQL/issues/1050) +- Restructured installation instructions to make it more readable. Implemented in [#1063](https://github.com/utPLSQL/utPLSQL/pull/1063), resolves [#1062](https://github.com/utPLSQL/utPLSQL/issues/1062) +- Updated database requirements in documentation. Implemented in [#1065](https://github.com/utPLSQL/utPLSQL/pull/1065), resolves [#1064](https://github.com/utPLSQL/utPLSQL/issues/1064) +- Removed duplicated call to install profiler tables. Implemented in [#1164](https://github.com/utPLSQL/utPLSQL/pull/1164), resolves [#1149](https://github.com/utPLSQL/utPLSQL/issues/1149) +- Fixed failing internal framework tests on Oracle 21c. Implemented in [#1158](https://github.com/utPLSQL/utPLSQL/pull/1158), resolves [#1151](https://github.com/utPLSQL/utPLSQL/issues/1151) +- Fixed confusing typo in documentation. Resolves [#1154](https://github.com/utPLSQL/utPLSQL/issues/1154) +- Moved build process from travis-ci.org to travis-ci.com. Implemented in [#1152](https://github.com/utPLSQL/utPLSQL/pull/1152) +- Added an example of reporter reporting all expectations, not only the failing ones. Implemented in [#1092](https://github.com/utPLSQL/utPLSQL/pull/1092) + + +# Downloads + +Download `v3.1.11` release version [here](https://github.com/utPLSQL/utPLSQL/releases/tag/v3.1.11) \ No newline at end of file diff --git a/docs/announcements/posts/2022/2022-02-24-version3.1.12-released.md b/docs/announcements/posts/2022/2022-02-24-version3.1.12-released.md new file mode 100644 index 00000000..ffff12aa --- /dev/null +++ b/docs/announcements/posts/2022/2022-02-24-version3.1.12-released.md @@ -0,0 +1,38 @@ +--- +layout: post +title: "utPLSQL v3.1.12 released" +date: + created: 2022-02-24 +categories: + - "releases" + - "utplsql-core" + +--- + +# Changes in release 3.1.12 + +## New features + - Added support for description in the `--%disabled` annotation. See [documentation](https://github.com/utPLSQL/utPLSQL/blob/4515e0b5a3b4b0de0c2198db3235ef8614bff4d8/docs/userguide/annotations.md#disabled). Implemented in: [#1183](https://github.com/utPLSQL/utPLSQL/pull/1183), resolves [#610](https://github.com/utPLSQL/utPLSQL/issues/610). + - Added support for native `JSON` datatype on Oracle `21c`. Implemented in [#1181](https://github.com/utPLSQL/utPLSQL/pull/1181), resolves [#1114](https://github.com/utPLSQL/utPLSQL/issues/1114). + - Added new mather `to_be_within( distance|pct ).of_(expoected)`. See [documentation](https://github.com/utPLSQL/utPLSQL/blob/fd7ef9c14111a48e03fff7851f990c7192539170/docs/userguide/expectations.md#to_be_within-of). Implemented in [#1076](https://github.com/utPLSQL/utPLSQL/pull/1076), resolves [#77](https://github.com/utPLSQL/utPLSQL/issues/77). + +## Enhancements + +- Improved performance of SQL used to retrieve Coverage sources. Implemented in [#1187](https://github.com/utPLSQL/utPLSQL/pull/1187), resolves [#1169](https://github.com/utPLSQL/utPLSQL/issues/1169). +- Added ability for utPLSQL to gather coverage on code invoking DBMS_STATS package. Implemented in [#1184](https://github.com/utPLSQL/utPLSQL/pull/1184), resolves [#1097](https://github.com/utPLSQL/utPLSQL/issues/1097), [#1094](https://github.com/utPLSQL/utPLSQL/issues/1094). +- Fixed typos and improved documentation. Implemented in [#1173](https://github.com/utPLSQL/utPLSQL/pull/1173), [#1171](https://github.com/utPLSQL/utPLSQL/pull/1171) + +## Bug fixes + +- Actual and Expected are now correctly reported when comparing `JSON` data. Implemented in [#1181](https://github.com/utPLSQL/utPLSQL/pull/1181), resolves [#1113](https://github.com/utPLSQL/utPLSQL/issues/1113). +- Packages with removed annotations are now correctly recognized as non-utPLSQL packages. Implemented in [#1180](https://github.com/utPLSQL/utPLSQL/pull/1180), resolves [#1177](https://github.com/utPLSQL/utPLSQL/issues/1177). +- Fixed issues with comparison of nested object structures. Implemented in [#1179](https://github.com/utPLSQL/utPLSQL/pull/1179), resolves [#1082](https://github.com/utPLSQL/utPLSQL/issues/1082), [#1083](https://github.com/utPLSQL/utPLSQL/issues/1083), [#1098](https://github.com/utPLSQL/utPLSQL/issues/1098). + + +## Internal improvements + +- Moved build and test process for utPLSQL from Travis to GithubActions. Implemented in [#1175](https://github.com/utPLSQL/utPLSQL/pull/1175) + +# Downloads + +Download `v3.1.12` release version [here](https://github.com/utPLSQL/utPLSQL/releases/tag/v3.1.12) \ No newline at end of file diff --git a/docs/announcements/posts/2022/2022-06-10-maven-plugin-version3.1.10-released.md b/docs/announcements/posts/2022/2022-06-10-maven-plugin-version3.1.10-released.md new file mode 100644 index 00000000..39a5d460 --- /dev/null +++ b/docs/announcements/posts/2022/2022-06-10-maven-plugin-version3.1.10-released.md @@ -0,0 +1,15 @@ +--- +layout: post +title: "utPLSQL-maven-plugin v3.1.10 released" +date: + created: 2022-06-10 +categories: + - "releases" + - "utplsql-maven-plugin" +--- + + +# Changes in release 3.1.10 + +## What's Changed +* Add new `` parameter - resolves [#70](https://github.com/utPLSQL/utPLSQL-maven-plugin/issues/70) diff --git a/docs/announcements/posts/2022/2022-06-13-cli-version3.1.9-released.md b/docs/announcements/posts/2022/2022-06-13-cli-version3.1.9-released.md new file mode 100644 index 00000000..33ab9dfb --- /dev/null +++ b/docs/announcements/posts/2022/2022-06-13-cli-version3.1.9-released.md @@ -0,0 +1,20 @@ +--- +layout: post +title: "utPLSQL-cli v3.1.9 released" +date: + created: 2022-06-13 +categories: + - "releases" + - "utplsql-cli" +--- + + +# Changes in release 3.1.9 + +## What's Changed +* Bugfix/Locale-Info and Nullpointer by [@pesse](https://github.com/pesse) in [#171](https://github.com/utPLSQL/utPLSQL-cli/pull/171) +* Feature/cleanup maven jdbc by [@jgebal](https://github.com/jgebal) in [#176](https://github.com/utPLSQL/utPLSQL-cli/pull/176) +* Support `a_coverage_schemes` option of utPLSQL by [@pesse](https://github.com/pesse) in [#180](https://github.com/utPLSQL/utPLSQL-cli/pull/180) +* Feature/GitHub actions by [@jgebal](https://github.com/jgebal) in [#202](https://github.com/utPLSQL/utPLSQL-cli/pull/202) +* Add new --ora-stuck-timeout parameter by [@pesse](https://github.com/pesse) in [#198](https://github.com/utPLSQL/utPLSQL-cli/pull/198) +* Update dependencies by [@pesse](https://github.com/pesse) in [#204](https://github.com/utPLSQL/utPLSQL-cli/pull/204) diff --git a/docs/announcements/posts/2022/2022-10-11-new-website-design.md b/docs/announcements/posts/2022/2022-10-11-new-website-design.md new file mode 100644 index 00000000..0ce1f924 --- /dev/null +++ b/docs/announcements/posts/2022/2022-10-11-new-website-design.md @@ -0,0 +1,27 @@ +--- +layout: post +title: "New website design" +date: + created: 2022-10-12 +categories: + - "website" +--- + + +Today is [#JoelKallmanDay](https://twitter.com/hashtag/JoelKallmanDay?f=live). + +As memorial of Joel Kallman, on this day utPLSQL launched its new website using different engine. + +We have moved away from using [Jekyll](https://jekyllrb.com/) with GitHub Pages to host project and organization sites. +[Jekyll](https://jekyllrb.com/) was simply too much hussle and we used [MkDocs](https://www.mkdocs.org/) to generate offline documentation for utPLSQL that was packaged into the release zip file. + +So instead of using two different methods, wei will now use only one. [MkDocs](https://www.mkdocs.org/) is now used for both utPSLQL offline and for online organization and project pages. + +Thanks to wonderful [material](https://squidfunk.github.io/mkdocs-material/) theme and [mike](https://github.com/jimporter/mike)(versioning plugin) for MkDocs you may now enjoy the following new features: + +- dark & light theme +- better navigation and menu in utPLSQL documentation +- documentation version dropdown +- powerful and fast search within documentation + +Hopefully, you will like the changes and enhancements. All the permanent links to old site should still be working. \ No newline at end of file diff --git a/docs/announcements/posts/2022/2022-12-11-version3.1.13-released.md b/docs/announcements/posts/2022/2022-12-11-version3.1.13-released.md new file mode 100644 index 00000000..2e57cd4c --- /dev/null +++ b/docs/announcements/posts/2022/2022-12-11-version3.1.13-released.md @@ -0,0 +1,41 @@ +--- +layout: post +title: "utPLSQL v3.1.13 released" +date: + created: 2022-12-11 +categories: + - "releases" + - "utplsql-core" + +--- + +# Changes in release 3.1.13 + + +## New features + + - Add ability to run tests by part of a name. Fixed in [#1203](https://github.com/utPLSQL/utPLSQL/pull/1203), resolves [#470](https://github.com/utPLSQL/utPLSQL/issues/470) + +## Enhancements + + - Added documentation section on creating a custom reporter. Fixed in [#1225](https://github.com/utPLSQL/utPLSQL/pull/1225), resolves [#710](https://github.com/utPLSQL/utPLSQL/issues/701) + - Add ability to specify code coverage objects include/exclude masks as regular expressions. Fixed in [#1186](https://github.com/utPLSQL/utPLSQL/issues/1186), resolves [#1053](https://github.com/utPLSQL/utPLSQL/issues/1053) + + +## Bug fixes + + - Comparing collection that have long type names. Fixed in [#1238](https://github.com/utPLSQL/utPLSQL/issues/1238), resolves [#1235](https://github.com/utPLSQL/utPLSQL/issues/1235). + - Code coverage reporting on code with long lines. Fixed in [#1240](https://github.com/utPLSQL/utPLSQL/issues/1240), resolves [#1232](https://github.com/utPLSQL/utPLSQL/issues/1232), [#1087](https://github.com/utPLSQL/utPLSQL/issues/1087). + - Code coverage reporting does not exclude tests. Fixed in [#1226](https://github.com/utPLSQL/utPLSQL/issues/1226), resolves [#1222](https://github.com/utPLSQL/utPLSQL/issues/1222). + - Uninstall script buffer overflow. Fixed in [#1221](https://github.com/utPLSQL/utPLSQL/issues/1221), resolves [#1220](https://github.com/utPLSQL/utPLSQL/issues/1220). + + +## Internal improvements + + - Improved process of generating utPLSQL documentation. Implemented in [689bbd0](https://github.com/utPLSQL/utPLSQL/commit/689bbd0e365ed919315c29727bc10fbfc0dadce8), resolves [#1237](https://github.com/utPLSQL/utPLSQL/issues/1237). + - Removed username env variables for internal development. Implemented in [#1201](https://github.com/utPLSQL/utPLSQL/issues/1221), resolves [#1200](https://github.com/utPLSQL/utPLSQL/issues/1200). + - Test execution data of utPLSQL project not showing on SonarCloud. Implemented in [#1199](https://github.com/utPLSQL/utPLSQL/issues/1199), resolves [#1198](https://github.com/utPLSQL/utPLSQL/issues/1198). + +## Downloads + +Download `v3.1.13` release version [here](https://github.com/utPLSQL/utPLSQL/releases/tag/v3.1.13) diff --git a/docs/announcements/posts/2024/2024-02-19-version3.1.14-released.md b/docs/announcements/posts/2024/2024-02-19-version3.1.14-released.md new file mode 100644 index 00000000..6f3b35e5 --- /dev/null +++ b/docs/announcements/posts/2024/2024-02-19-version3.1.14-released.md @@ -0,0 +1,32 @@ +--- +layout: post +title: "utPLSQL v3.1.14 released" +date: + created: 2024-02-19 +categories: + - "releases" + - "utplsql-core" + +--- + +## What's Changed +* Added support for `and` and `or` operators when running tests by tags by [@lwasylow](https://github.com/lwasylow) in [#1250](https://github.com/utPLSQL/utPLSQL/pull/1250) +* Allow for test runs over 4 hours by [@jgebal](https://github.com/jgebal) in [#1243](https://github.com/utPLSQL/utPLSQL/pull/1243) +* Framework performance improvements by [@jgebal](https://github.com/jgebal) in [#1249](https://github.com/utPLSQL/utPLSQL/pull/1249) +* Support multiple expectation failures with teamcity reporter by [@jgebal](https://github.com/jgebal) in [#1251](https://github.com/utPLSQL/utPLSQL/pull/1251) +* Address issue where the not_to(contain) not run correctly by [@lwasylow](https://github.com/lwasylow) in [#1246](https://github.com/utPLSQL/utPLSQL/pull/1246) +* Fix regex to be NLS_SORT independent by [@jgebal](https://github.com/jgebal) in [#1253](https://github.com/utPLSQL/utPLSQL/pull/1253) +* Fix output length error and output buffer. by [@jgebal](https://github.com/jgebal) in [#1255](https://github.com/utPLSQL/utPLSQL/pull/1255) +* (docs): Update running-unit-tests.md - remove example by [@gassenmj](https://github.com/gassenmj) in [#1261](https://github.com/utPLSQL/utPLSQL/pull/1261) +* The line-rate is not recorded for packages and classes in cobertura coverage reporter by [@lwasylow](https://github.com/lwasylow) in [#1269](https://github.com/utPLSQL/utPLSQL/pull/1269) +* (docs): Fix nested list issue by [@iamrachid](https://github.com/iamrachid) in [#1274](https://github.com/utPLSQL/utPLSQL/pull/1274) +* Update TFS reporter to correct format by [@lwasylow](https://github.com/lwasylow) in [#1270](https://github.com/utPLSQL/utPLSQL/pull/1270) + +## New Contributors +* [@gassenmj](https://github.com/gassenmj) made their first contribution in [#1261](https://github.com/utPLSQL/utPLSQL/pull/1261) +* [@iamrachid](https://github.com/iamrachid) made their first contribution in [#1274](https://github.com/utPLSQL/utPLSQL/pull/1274) + +**Full Changelog**: [v3.1.13...v3.1.14](https://github.com/utPLSQL/utPLSQL/compare/v3.1.13...v3.1.14) + +---------------------------- +[Download utPLSQL release `v3.1.14` here](https://github.com/utPLSQL/utPLSQL/releases/tag/v3.1.14) diff --git a/docs/announcements/posts/2026/2026-04-22-version3.2.01-released.md b/docs/announcements/posts/2026/2026-04-22-version3.2.01-released.md new file mode 100644 index 00000000..b60e6cc5 --- /dev/null +++ b/docs/announcements/posts/2026/2026-04-22-version3.2.01-released.md @@ -0,0 +1,26 @@ +--- +layout: post +title: "utPLSQL v3.2.01 released" +date: + created: 2026-04-22 +categories: + - "releases" + - "utplsql-core" + +--- + +## Important + - Dropped support for Oracle Database versions older than 19c + +## New features + - Add TAP reporter by @WayneNani in [#1305](https://github.com/utPLSQL/utPLSQL/pull/1305) + +## Enhancements and bug fixes + - Added duplicate detection on cursor comparison using `join_by` by @lwasylow in [#1295](https://github.com/utPLSQL/utPLSQL/pull/1295) + - Fix code causing the object duration Oracle exception on oracle 23.26 by @lwasylow in [#1310](https://github.com/utPLSQL/utPLSQL/pull/1310) + - Packages with annotation-like comments are not test suites by @jgebal in [#1313](https://github.com/utPLSQL/utPLSQL/pull/1313) + - Performance improvements to annotation parsing by @lwasylow in [#1312](https://github.com/utPLSQL/utPLSQL/pull/1319) + - Updated documentation and copyright banners across source files @jgebal in [#1319](https://github.com/utPLSQL/utPLSQL/pull/1319) + +---------------------------- +[Download utPLSQL release v3.2.01 here](https://github.com/utPLSQL/utPLSQL/releases/tag/v3.2.01) diff --git a/docs/announcements/posts/2026/2026-05-24-version3.2.2-released.md b/docs/announcements/posts/2026/2026-05-24-version3.2.2-released.md new file mode 100644 index 00000000..229226a8 --- /dev/null +++ b/docs/announcements/posts/2026/2026-05-24-version3.2.2-released.md @@ -0,0 +1,22 @@ +--- +layout: post +title: "utPLSQL v3.2.2 released" +date: + created: 2026-05-24 +categories: + - "releases" + - "utplsql-core" + +--- + +## What's Changed +* Filtering by tags fixed for schemas containing suite-paths and contexts by @jgebal in [#1325](https://github.com/utPLSQL/utPLSQL/pull/1325) +* Fixed issue with reporter failing to initialize by @jgebal in [#1354](https://github.com/utPLSQL/utPLSQL/pull/1354) +* Fixed issue with duplicate sources from dba_source by @jgebal in [#1355](https://github.com/utPLSQL/utPLSQL/pull/1355) +* Allow HTML coverage on FIPS-enabled DB by @jgebal in [#1356](https://github.com/utPLSQL/utPLSQL/pull/1356) + + +**Full Changelog**: [v3.2.01...v3.2.2](https://github.com/utPLSQL/utPLSQL/compare/v3.2.01...v3.2.2) + +---------------------------- +[Download utPLSQL release v3.2.2 here](https://github.com/utPLSQL/utPLSQL/releases/tag/v3.2.2) diff --git a/docs/announcements/posts/2026/2026-06-15-website-navigation-improvements.md b/docs/announcements/posts/2026/2026-06-15-website-navigation-improvements.md new file mode 100644 index 00000000..eacedfa8 --- /dev/null +++ b/docs/announcements/posts/2026/2026-06-15-website-navigation-improvements.md @@ -0,0 +1,35 @@ +--- +layout: post +title: "Website navigation improvements" +date: + created: 2026-06-15 +categories: + - "website" +--- + +We've been busy improving the utPLSQL website experience over the past couple of days. + + + +## Shared navigation bar + +The top navigation bar shared across all utPLSQL sites has been redesigned and refactored. +It is now more consistent and makes it easier to navigate utPLSQL project and organization's pages. + +## Light / Dark / Auto theme switching + +The theme toggle has been upgraded from a simple light/dark switch to a three-way control: + +- **Light** — always light +- **Dark** — always dark +- **Auto** — follows your system preference + +Your choice is remembered across visits. + +## Announcements reorganized + +The Announcements are now presented in a blog-like style with categories section expanded by default, making it easier to find relevant announcements at a glance. +The archive by year has been removed in favour of a cleaner post listing on the index page. + +We hope these improvements make the site more pleasant to use. +Feel free to share feedback in the [GitHub Discussions](https://github.com/org/discussions). diff --git a/docs/announcements/posts/2026/2026-06-17-utPLSQL-for-SQL-Developer-2.0.1-released.md b/docs/announcements/posts/2026/2026-06-17-utPLSQL-for-SQL-Developer-2.0.1-released.md new file mode 100644 index 00000000..caceb13f --- /dev/null +++ b/docs/announcements/posts/2026/2026-06-17-utPLSQL-for-SQL-Developer-2.0.1-released.md @@ -0,0 +1,22 @@ +--- +layout: post +title: "utPLSQL for SQL Developer v2.0.0 and v2.0.1" +date: + created: 2026-06-17 +categories: + - "releases" + - "utplsql-sql-developer" + +--- + +This is a maintenance release all dependencies and changes by @PhilippSalvisberg + +## What's Changed +* Enforces SQL Developer version 24.3.1.347.1826 with JDK 17 +* Bumps all dependencies + + +**Full Changelog**: [v1.4.1...v2.0.1](https://github.com/utPLSQL/utPLSQL-SQLDeveloper/compare/v1.4.1...v2.0.1) + +---------------------------- +[Download utPLSQL for SQL Developer v2.0.1 here](https://github.com/utPLSQL/utPLSQL-SQLDeveloper/releases/tag/v2.0.1) diff --git a/docs/announcements/posts/2026/2026-07-10-version3.2.3-released.md b/docs/announcements/posts/2026/2026-07-10-version3.2.3-released.md new file mode 100644 index 00000000..f9e9956b --- /dev/null +++ b/docs/announcements/posts/2026/2026-07-10-version3.2.3-released.md @@ -0,0 +1,24 @@ +--- +layout: post +title: "utPLSQL v3.2.3 released" +date: + created: 2026-07-10 +categories: + - "releases" + - "utplsql-core" +--- + +## What's Changed +* Fix issue with `UT_TAP_REPORTER` on Oracle 23.26 by @jgebal in [#1359](https://github.com/utPLSQL/utPLSQL/pull/1359) +* Fixed support for camelCase in context `--%name` annotation. by @jgebal in [#1361](https://github.com/utPLSQL/utPLSQL/pull/1361) +* utPLSQL can be installed in editioned schema. by @jgebal in [#1362](https://github.com/utPLSQL/utPLSQL/pull/1362) +* Removed coveralls reporter by @jgebal in [#1363](https://github.com/utPLSQL/utPLSQL/pull/1363) +* Clarify behavior of before/after procedures in suitepath by @jgebal in [#1364](https://github.com/utPLSQL/utPLSQL/pull/1364) +* `throws` can reference exception without schema or package name by @jgebal in [#1365](https://github.com/utPLSQL/utPLSQL/pull/1365) +* `throws` works with uninitialized exception variables by @jgebal in [#1366](https://github.com/utPLSQL/utPLSQL/pull/1366) + + +**Full Changelog**: [v3.2.2...v.3.2.3](https://github.com/utPLSQL/utPLSQL/compare/v3.2.2...v.3.2.3) + +---------------------------- +[Download utPLSQL release v3.2.3 here](https://github.com/utPLSQL/utPLSQL/releases/tag/v3.2.3) diff --git a/docs/announcements/posts/2026/2026-08-14-next-chapter-for-utPLSQL.md b/docs/announcements/posts/2026/2026-08-14-next-chapter-for-utPLSQL.md new file mode 100644 index 00000000..33615015 --- /dev/null +++ b/docs/announcements/posts/2026/2026-08-14-next-chapter-for-utPLSQL.md @@ -0,0 +1,86 @@ +--- +layout: post +title: "Next chapter for utPLSQL" +date: + created: 2026-08-12 +categories: + - "news" +pin: false +--- + +## Looking back +utPLSQL v3 has come a long way since it was first released in 2017. +It has already been over 10 years since the first discussions about starting the project began. +However, development slowed after 2019, and by 2024 the project had become inactive. +Life took me in a different direction for a few years, and the after-hours project understandably took a back seat. + + +## The current state +In the last year, a few people reached out to me asking whether the project is still alive. +Regulated companies often can't use software that isn't under active maintenance, +and others simply treat it as a security risk. + +In recent months I have invested time in bringing the project back to life, +refreshing all libraries and dependencies, fixing build processes and pipelines, +and releasing new versions for the main project and tools. +The documentation was restructured and updated, and discussions were moved to [GitHub](https://github.com/orgs/utPLSQL/discussions). + +## The future roadmap + +I realized that **utPLSQL needs a clear vision for its future development**. Without one, +it risks becoming legacy and dying, like many other open-source projects have. + +The software world keeps moving forward. New versions of Oracle Database, programming languages, developer tools and libraries are released continuously. + +At the same time, there are many ideas and plans that were never implemented as part of the development of utPLSQL v3. Those are still very much valid and would be highly valuable additions to the framework. They would make PL/SQL development and testing even more modern and smoother. + +I have created a high-level roadmap that highlights the key points of the future development of utPLSQL core. + +### Phase 1 - Core + +- Security model rework: CBAC for framework internals +- Drop legacy version support (11g, 12c, 18c) +- Annotations, suite structure & module rework + +### Phase 2 - Modernization + +- Code coverage rework +- Reporter API & assertion output improvements +- Modern database capabilities (data types) + +### Phase 3 - Developer experience + +- Framework usage - telemetry +- Developer/tester productivity (data setup, mocking, scope narrowing) + +### Phase 4 - New capability + +- cucumber-utPLSQL: Gherkin BDD/ATDD test runner for PL/SQL + +The detailed roadmap is available in the [utPLSQL org GitHub Discussions](https://github.com/orgs/utPLSQL/discussions/15). + +## Sustainability + +The intention is to keep utPLSQL under active development and create possibilities for companies and individuals to get direct access to the development team, with options for knowledge sharing, consultations, and more. + +Working on the above requires significant investment of thought, time and effort. It is not sustainable to keep developing utPLSQL without support from those who use it and benefit from it daily. + +Over the last decade, this project has been a significant part of my life as an engineer and professional software developer. I would like to see it thrive rather than fade into deprecation and obscurity. + +## Sponsorship + +!!! info "Update - September 25, 2026" + utPLSQL Development Labs Ltd has been incorporated to steward the project. Sponsorships and other support arrangements are now handled by the company - contact [sponsors@utPLSQL.org](mailto:sponsors@utPLSQL.org). See [Incorporation of utPLSQL Development Labs Ltd](2026-09-25_incorporation_of_utPLSQL.md). + +I am currently working on opening utPLSQL for sponsorship, and I'll share the tiers and details in a follow-up post once everything is in place. + +If you or your company would benefit from active development of utPLSQL and want to be notified when sponsorship opens then please: + +- comment on [this GitHub discussion](https://github.com/orgs/utPLSQL/discussions/22) +- or contact me directly on [LinkedIn](https://www.linkedin.com/in/jacek-gebal-6678301/) [X](https://x.com/GebalJacek), [BlueSky](https://bsky.app/profile/jacek-gebal.bsky.social) +- or contact utPLSQL.org on [LinkedIn](https://www.linkedin.com/company/utplsql/), [X](https://x.com/utPLSQL), [BlueSky](https://bsky.app/profile/utplsql.org) + +Your responses will help me gauge interest as I finalize the preparations. + +> Jacek Gebal
+> @utPLSQL \ No newline at end of file diff --git a/docs/announcements/posts/2026/2026-09-25_incorporation_of_utPLSQL.md b/docs/announcements/posts/2026/2026-09-25_incorporation_of_utPLSQL.md new file mode 100644 index 00000000..674774b9 --- /dev/null +++ b/docs/announcements/posts/2026/2026-09-25_incorporation_of_utPLSQL.md @@ -0,0 +1,40 @@ +--- +layout: post +title: "Incorporation of utPLSQL Development Labs Ltd" +date: + created: 2026-09-25 +categories: + - "news" +pin: true +--- + +# Incorporation of utPLSQL Development Labs Ltd + +For many years, utPLSQL has been built and maintained through the contributions of dedicated and passionate engineers from the community. + +To provide a sustainable legal structure for the project, utPLSQL is now under the legal custody of **utPLSQL Development Labs Ltd**. + + +The incorporation does **not** change the open-source nature of utPLSQL. All existing utPLSQL projects remain free to use and open source, licensed under the Apache License 2.0. + +The company has been established primarily to provide the infrastructure needed to sustain and grow the project. In particular, it will allow us to: + +* establish a legal entity that can hold the project's name, branding and assets, providing continuity as maintainers and contributors change; +* manage bookkeeping, finances, contracts, invoices, sponsorships and other arrangements with supporters; +* support active maintenance and development of utPLSQL and help the project grow to its full potential; +* make it possible to fund dedicated development work where appropriate. + +**Sponsorship or financial support does not provide ownership of utPLSQL or control over its direction.** Contributions to the project remain open to the community. + +## Roadmap + +Alongside this transition, I have published a roadmap outlining the major architectural and feature initiatives planned for utPLSQL. The roadmap is intended to provide visibility into the direction of the project and serve as an entry point for discussions around individual initiatives and their implementation. + +See the [utPLSQL Roadmap on GitHub](https://github.com/orgs/utPLSQL/discussions/15). + +The goal is to provide utPLSQL with a more sustainable foundation while preserving its open-source nature and community-driven development. + +For a more personal perspective on the history behind this decision, the motivations for establishing utPLSQL Development Labs Ltd, and the thinking behind this next chapter for utPLSQL, I have written a more detailed post on [oraclethoughts.com](https://oraclethoughts.com/blog/2026/09/25/incorporation_of_utPLSQL/). + +> Jacek Gebal
+> @utPLSQL diff --git a/docs/announcements/posts/2026/2026-09-27-cli-and-maven-plugin-version3.2.1-released.md b/docs/announcements/posts/2026/2026-09-27-cli-and-maven-plugin-version3.2.1-released.md new file mode 100644 index 00000000..d0de9a1e --- /dev/null +++ b/docs/announcements/posts/2026/2026-09-27-cli-and-maven-plugin-version3.2.1-released.md @@ -0,0 +1,33 @@ +--- +layout: post +title: "utPLSQL-cli and utPLSQL-maven-plugin v3.2.1 released" +date: + created: 2026-09-27 +categories: + - "releases" + - "utplsql-cli" + - "utplsql-maven-plugin" +--- + +Both utPLSQL-cli and utPLSQL-maven-plugin v3.2.1 are now available, adding support for Oracle Wallet (Secure External Password Store) connections. + +## utPLSQL-cli v3.2.1 + +### What's Changed +* Allow `/@TNS` connections using Oracle Wallet (Secure External Password Store) by @jgebal in [#230](https://github.com/utPLSQL/utPLSQL-cli/pull/230) +* Update of java-api-version dependency by @jgebal in [#231](https://github.com/utPLSQL/utPLSQL-cli/pull/231) +* Don't reveal credentials in log and error output by @jgebal in [#232](https://github.com/utPLSQL/utPLSQL-cli/pull/232) + +**Full Changelog**: [v3.2.0...v3.2.1](https://github.com/utPLSQL/utPLSQL-cli/compare/v3.2.0...v3.2.1) + +[Download utPLSQL-cli v3.2.1 here](https://github.com/utPLSQL/utPLSQL-cli/releases/tag/v3.2.1) + +## utPLSQL-maven-plugin v3.2.1 + +### What's Changed +* Added support for Oracle Wallet (Secure External Password Store) connections by @jgebal in [#82](https://github.com/utPLSQL/utPLSQL-maven-plugin/pull/82) +* Added support for skipping utPLSQL tests with `-DskipTests` and `-Dmaven.test.skip` by @jgebal in [#83](https://github.com/utPLSQL/utPLSQL-maven-plugin/pull/83) + +**Full Changelog**: [v3.2.0...v3.2.1](https://github.com/utPLSQL/utPLSQL-maven-plugin/compare/v3.2.0...v3.2.1) + +[Download utPLSQL-maven-plugin v3.2.1 here](https://github.com/utPLSQL/utPLSQL-maven-plugin/releases/tag/v3.2.1) diff --git a/docs/announcements/posts/2026/2026-10-11-utplsql-open-for-sponsorship.md b/docs/announcements/posts/2026/2026-10-11-utplsql-open-for-sponsorship.md new file mode 100644 index 00000000..21f3b80d --- /dev/null +++ b/docs/announcements/posts/2026/2026-10-11-utplsql-open-for-sponsorship.md @@ -0,0 +1,31 @@ +--- +layout: post +title: "utPLSQL is now open for sponsorship" +date: + created: 2026-10-11 +categories: + - "news" +description: "utPLSQL opens for sponsorship to help fund maintenance and development: organization tiers, commercial support and consulting." +pin: true +--- + +In last months, we took steps to formalise utPLSQL and to give it a legal home under utPSLQL Development Labs Ltd. +With this being almost complete, it is now time to open utPLSQL for sponsorship that will allow for sustained development of this great framework. + +utPLSQL remains free to use and open source (Apache 2.0). + + + + +Sponsorship is a way to collect funds required to allow for work on: and new features and support for new Oracle capabilities, compatibility updates, documentation, issue triage, hosting. + +## What is available + +- **Organization sponsorship** from 100 EUR / month, with recognition on utplsql.org, GitHub and the framework README +- **Commercial support** with priority triage, a named contact and private consultation hours +- **Consulting, training and problem-solving** for teams adopting or scaling utPLSQL +- **Individual sponsorship** through GitHub Sponsors, any amount + +Sponsorship does not buy influence over the roadmap, and the project stays free for everyone. + +Details are on the [Sponsorship page](../../../sponsorship.md). diff --git a/docs/announcements/posts/2026/2026-10-17-cli-version3.2.2-released.md b/docs/announcements/posts/2026/2026-10-17-cli-version3.2.2-released.md new file mode 100644 index 00000000..aebbdb58 --- /dev/null +++ b/docs/announcements/posts/2026/2026-10-17-cli-version3.2.2-released.md @@ -0,0 +1,53 @@ +--- +layout: post +title: "utPLSQL-cli v3.2.2 released" +date: + created: 2026-10-17 +categories: + - "releases" + - "utplsql-cli" +--- + +## Highlights + +### Code coverage scope defined with regular expressions + +`utplsql run` has four new options that decide what is included in the coverage report by schema or object **name pattern**: + + +| Option | Meaning | +|-------------------------|--------------------------------------------------------------------| +| `-include-schema-expr` | report coverage only on schemas whose name matches the expression | +| `-exclude-schema-expr` | leave out schemas whose name matches the expression | +| `-include-object-expr` | report coverage only on objects whose name matches the expression | +| `-exclude-object-expr` | leave out objects whose name matches the expression | + +When project files are mapped to database objects (`-source_path` / `-test_path`), coverage is already limited to those files. +The new options are for code that cannot be mapped to project files. They allow for new packages that follow your naming conventions +to be covered (or left out) automatically, without updating a list of schemas or objects in your pipeline. + +```bash +utplsql run app/pass@db -p=app -f=ut_coverage_html_reporter -o=coverage.html \ + -include-schema-expr='^APP_' -exclude-schema-expr='_TEST$' -exclude-object-expr='_TMP$' +``` + +- Expressions are case-insensitive Oracle regular expressions. Object expressions are matched against the object name without the schema. +- If an include expression is given, `--coverage-schemes` and `-include` are ignored. All exclude options are always applied. +- The filters do not apply when coverage is gathered on project files (`-source_path` / `-test_path`). + +See [Filtering objects in coverage reports](https://www.utplsql.org/utPLSQL/latest/userguide/coverage.html#filtering-objects-in-coverage-reports) +and the [utPLSQL-cli documentation](https://www.utplsql.org/utPLSQL-cli.html). + +The utPLSQL Maven plugin supports the same filters (`includeSchemaExpr`, `excludeSchemaExpr`, `includeObjectExpr`, `excludeObjectExpr`) +and now documents them in detail. + + +## What's Changed +* Add coverage filter options by regular expression by @jgebal in [#233](https://github.com/utPLSQL/utPLSQL-cli/pull/233) +* Announce releases with the shared announce-release action by @jgebal in [#234](https://github.com/utPLSQL/utPLSQL-cli/pull/234) + + +**Full Changelog**: [v3.2.1...v3.2.2](https://github.com/utPLSQL/utPLSQL-cli/compare/v3.2.1...v3.2.2) + +---------------------------- +[Download utPLSQL-cli v3.2.2 here](https://github.com/utPLSQL/utPLSQL-cli/releases/tag/v3.2.2) diff --git a/docs/announcements/posts/2026/2026-10-17-maven-plugin-version3.2.2-released.md b/docs/announcements/posts/2026/2026-10-17-maven-plugin-version3.2.2-released.md new file mode 100644 index 00000000..6fb4bfec --- /dev/null +++ b/docs/announcements/posts/2026/2026-10-17-maven-plugin-version3.2.2-released.md @@ -0,0 +1,19 @@ +--- +layout: post +title: "utPLSQL-maven-plugin v3.2.2 released" +date: + created: 2026-10-17 +categories: + - "releases" + - "utplsql-maven-plugin" +--- + +## What's Changed +* Expand documentation and tests for coverage filters. by @jgebal in [#84](https://github.com/utPLSQL/utPLSQL-maven-plugin/pull/84) +* Announce releases with the shared announce-release action by @jgebal in [#85](https://github.com/utPLSQL/utPLSQL-maven-plugin/pull/85) + + +**Full Changelog**: [v3.2.1...v3.2.2](https://github.com/utPLSQL/utPLSQL-maven-plugin/compare/v3.2.1...v3.2.2) + +---------------------------- +[Download utPLSQL-maven-plugin v3.2.2 here](https://github.com/utPLSQL/utPLSQL-maven-plugin/releases/tag/v3.2.2) diff --git a/docs/assets/favicon.png b/docs/assets/favicon.png new file mode 100644 index 00000000..7c34109d Binary files /dev/null and b/docs/assets/favicon.png differ diff --git a/docs/assets/icon-transparent.png b/docs/assets/icon-transparent.png new file mode 100644 index 00000000..6e4534aa Binary files /dev/null and b/docs/assets/icon-transparent.png differ diff --git a/docs/assets/sqlcl-utplsql.jpg b/docs/assets/sqlcl-utplsql.jpg new file mode 100644 index 00000000..c6e368ff Binary files /dev/null and b/docs/assets/sqlcl-utplsql.jpg differ diff --git a/docs/assets/topbar.css b/docs/assets/topbar.css new file mode 100644 index 00000000..0ca47834 --- /dev/null +++ b/docs/assets/topbar.css @@ -0,0 +1,200 @@ +#utplsql-topbar { + background: #1565c0; + padding: 0 1rem; + display: flex; + align-items: center; + height: 2rem; + font-size: 0.7rem; + font-family: var(--md-text-font, -apple-system, BlinkMacSystemFont, "Segoe UI", sans-serif); + position: sticky; + top: 0; + z-index: 10; + box-shadow: 0 1px 3px rgba(0,0,0,0.25); + letter-spacing: 0.03em; +} + +#utplsql-topbar a { + color: rgba(255,255,255,0.88); + text-decoration: none; + padding: 0 0.5rem; + line-height: 2rem; + white-space: nowrap; + transition: color 0.15s; +} + +#utplsql-topbar a:hover, +#utplsql-topbar a.utplsql-active { + color: #fff; +} + +#utplsql-topbar .utplsql-brand { + font-weight: 700; + color: #fff; + padding-right: 0.75rem; + margin-right: 0.25rem; + border-right: 1px solid rgba(255,255,255,0.25); + display: flex; + align-items: center; + gap: 0.4rem; +} + +#utplsql-topbar .utplsql-brand-icon { + display: block; + width: 1.3rem; + height: 1.3rem; + flex-shrink: 0; + background-image: url('icon-transparent.png'); + background-repeat: no-repeat; + background-position: center; + background-size: contain; +} + +#utplsql-topbar .utplsql-controls { + margin-left: auto; + display: flex; + align-items: center; + gap: 0.1rem; +} + +#utplsql-topbar .utplsql-controls button { + background: none; + border: none; + cursor: pointer; + color: rgba(255,255,255,0.88); + padding: 0 0.4rem; + height: 2rem; + display: flex; + align-items: center; + transition: color 0.15s; + border-radius: 0.2rem; +} + +#utplsql-topbar .utplsql-controls button:hover { + color: #fff; +} + +#utplsql-topbar .utplsql-controls button svg { + width: 1rem; + height: 1rem; + fill: currentColor; + display: block; +} + +/* Material header sits below the topbar */ +.md-header, +.md-header--shadow { + top: 2rem !important; +} + +/* NOTE: .md-header__button and .md-header__option hiding is intentionally + NOT here — it is injected by topbar.js only after the topbar is built, + so that a JS failure leaves Material's original navigation intact. */ + +/* ── Org-site only ──────────────────────────────────────────────────────── + The org site sets data-utplsql-site="org" on in its template. + Sub-sites keep Material's title (version selector lives there) and tabs + (the only way to navigate between top-level sections like User Guide / + Reporting / About). + ─────────────────────────────────────────────────────────────────────── */ + +/* Hide Material's logo/title on the org site — brand lives in the topbar */ +[data-utplsql-site="org"] .md-header__title { + display: none !important; +} + +/* Hide tab bar on the org site — the shared topbar handles section nav */ +[data-utplsql-site="org"] .md-tabs { + display: none !important; +} + +/* Back-to-top button: push below topbar + header so it isn't hidden behind them */ +.md-top { + top: 4.4rem !important; +} + +/* Sidebar offset: org site has topbar + header (~2 + 2.4 = 4.4rem), no tabs. + Sub-sites have topbar + header + tabs (~2 + 2.4 + 2.4 = 6.8rem). */ +[data-utplsql-site="org"] .md-sidebar { + top: 4.4rem !important; +} + +.md-sidebar { + top: 6.8rem !important; +} + +/* Hamburger button — hidden by default, shown via media query on mobile */ +#utplsql-topbar .utplsql-hamburger { + display: none; + background: none; + border: none; + cursor: pointer; + color: rgba(255,255,255,0.88); + padding: 0 0.4rem; + height: 2rem; + align-items: center; + flex-shrink: 0; + transition: color 0.15s; +} + +#utplsql-topbar .utplsql-hamburger:hover { + color: #fff; +} + +#utplsql-topbar .utplsql-hamburger svg { + width: 1.2rem; + height: 1.2rem; + fill: currentColor; + display: block; +} + +/* Org site links injected into Material's sidebar drawer — desktop: hidden */ +#utplsql-drawer-nav { + display: none; +} + +@media screen and (max-width: 76.1875em) { + /* Hide nav links on mobile — sidebar drawer handles navigation */ + #utplsql-topbar a:not(.utplsql-brand) { + display: none; + } + + /* Show hamburger */ + #utplsql-topbar .utplsql-hamburger { + display: flex; + } + + /* Material's mobile search overlay is position:fixed from top:0. + Shift the whole search container (form + output together) below our topbar. */ + .md-search__inner { + padding-top: 2rem !important; + } + + /* Org site nav section at the top of the drawer */ + #utplsql-drawer-nav { + display: block; + padding: 0.6rem 0.8rem 0.4rem; + border-bottom: 1px solid var(--md-default-fg-color--lightest, rgba(0,0,0,.12)); + margin-bottom: 0.4rem; + } + + #utplsql-drawer-nav .utplsql-drawer-heading { + font-size: 0.65rem; + font-weight: 700; + letter-spacing: 0.08em; + text-transform: uppercase; + color: var(--md-default-fg-color--light); + padding-bottom: 0.3rem; + } + + #utplsql-drawer-nav a { + display: block; + padding: 0.25rem 0; + color: var(--md-typeset-a-color); + text-decoration: none; + font-size: 0.75rem; + } + + #utplsql-drawer-nav a:hover { + color: var(--md-accent-fg-color); + } +} diff --git a/docs/assets/topbar.js b/docs/assets/topbar.js new file mode 100644 index 00000000..df7b7e6f --- /dev/null +++ b/docs/assets/topbar.js @@ -0,0 +1,326 @@ +/** + * utPLSQL shared top navigation bar. + * Published at https://utplsql.org/assets/topbar.js + * + * CSS lives in topbar.css (loaded via extra_css / template link) so it + * survives Material's instant-navigation head replacement. + * + * Sub-repositories load this script via their docs/overrides/main.html template. + * Update this file to change the shared nav across all sub-sites simultaneously. + */ +(function () { + 'use strict'; + + /* Base URL comes from the MkDocs site_url injected by the template. + Sub-sites that load this script from utplsql.org don't set the variable, + so they fall back to the hardcoded production URL. */ + var BASE = (window.utplsqlBaseUrl || 'https://www.utplsql.org/').replace(/\/+$/, ''); + + var NAV = [ + { label: 'Home', url: BASE + '/' }, + { label: 'Announcements', url: BASE + '/announcements/' }, + { label: 'Documentation', url: BASE + '/documentation.html' }, + { label: 'Downloads', url: BASE + '/downloads.html' }, + { label: 'Resources', url: BASE + '/resources.html' }, + { label: 'Sponsorship', url: BASE + '/sponsors.html' }, + { label: 'About', url: BASE + '/about.html' }, + { label: 'Contributing', url: BASE + '/contributing.html' }, + ]; + + var SVG_MENU = + '' + + '' + + ''; + + /* Icons from Material for MkDocs icon set, matching the org's mkdocs.yml palette config. + Cycle order: auto → light → dark → auto + auto → material/lightbulb-auto-outline (following OS preference) + light → material/lightbulb-outline (forced light, click for dark) + dark → material/lightbulb (forced dark, click for auto) */ + var SVG_AUTO = + '' + + '' + + ''; + + var SVG_LIGHT = + '' + + '' + + ''; + + var SVG_DARK = + '' + + '' + + ''; + + /* Module-level references so the built bar can be re-inserted on instant + navigation without recreating it (prevents the logo from reloading). */ + var themeBtn = null; + var savedBar = null; + + /* ── Theme state ───────────────────────────────────────────────────────── + 'utplsql-scheme' in localStorage holds one of three values: + 'auto' — follow the OS prefers-color-scheme (default when unset) + 'default' — forced light mode + 'slate' — forced dark mode + ─────────────────────────────────────────────────────────────────────── */ + + function getPreference() { + try { return localStorage.getItem('utplsql-scheme') || 'auto'; } catch (e) {} + return 'auto'; + } + + function osPrefersDark() { + return window.matchMedia('(prefers-color-scheme: dark)').matches; + } + + /* Returns the effective Material colour scheme for the current preference. */ + function effectiveScheme(pref) { + if (pref === 'slate' || pref === 'default') return pref; + return osPrefersDark() ? 'slate' : 'default'; /* auto */ + } + + function applyScheme(scheme) { + document.body.setAttribute('data-md-color-scheme', scheme); + /* Keep Material's own __palette in sync so its JS doesn't fight us. */ + try { + var stored = JSON.parse(localStorage.getItem('__palette') || 'null'); + if (stored && stored.color) { + stored.color.scheme = scheme; + stored.index = scheme === 'slate' ? 1 : 0; + } else { + stored = { index: scheme === 'slate' ? 1 : 0, color: { scheme: scheme } }; + } + localStorage.setItem('__palette', JSON.stringify(stored)); + } catch (e) {} + } + + function updateThemeIcon() { + if (!themeBtn) return; + var pref = getPreference(); + if (pref === 'auto') { + themeBtn.innerHTML = SVG_AUTO; + themeBtn.setAttribute('aria-label', 'Theme: auto (following OS) — click for light'); + } else if (pref === 'default') { + themeBtn.innerHTML = SVG_LIGHT; + themeBtn.setAttribute('aria-label', 'Theme: light — click for dark'); + } else { + themeBtn.innerHTML = SVG_DARK; + themeBtn.setAttribute('aria-label', 'Theme: dark — click for auto'); + } + } + + /* Re-applies our stored preference after Material's navigation re-init. */ + function applyStoredScheme() { + var pref = getPreference(); + applyScheme(effectiveScheme(pref)); + updateThemeIcon(); + } + + function injectDrawerNav() { + /* Only needed on mobile — desktop shows links in the topbar itself. */ + if (!window.matchMedia('(max-width: 76.1875em)').matches) return; + + /* Already injected and still in the DOM — nothing to do. */ + if (document.getElementById('utplsql-drawer-nav')) return; + + var inner = document.querySelector('.md-sidebar--primary .md-sidebar__inner'); + if (!inner) return; + + var section = document.createElement('nav'); + section.id = 'utplsql-drawer-nav'; + section.setAttribute('aria-label', 'utPLSQL.org site navigation'); + + var heading = document.createElement('div'); + heading.className = 'utplsql-drawer-heading'; + heading.textContent = 'utPLSQL.org'; + section.appendChild(heading); + + NAV.forEach(function (item) { + var a = document.createElement('a'); + a.href = item.url; + a.textContent = item.label; + section.appendChild(a); + }); + + inner.insertBefore(section, inner.firstChild); + } + + function updateActiveLink() { + var bar = document.getElementById('utplsql-topbar'); + if (!bar) return; + var current = window.location.href; + bar.querySelectorAll('a:not(.utplsql-brand)').forEach(function (a) { + var isActive = a.href !== BASE + '/' && current.indexOf(a.href) === 0; + a.classList.toggle('utplsql-active', isActive); + }); + } + + + function ensureStyle() { + /* Re-inject the hiding style if Material's instant navigation removed it. */ + if (!document.getElementById('utplsql-topbar-style')) { + var s = document.createElement('style'); + s.id = 'utplsql-topbar-style'; + s.textContent = + '.md-header__button:not([for="__search"]) { display: none !important; }' + + '.md-header__option { position: absolute !important; left: -9999px !important; }' + + '.md-top { top: 4.4rem !important; z-index: 11; }'; + document.head.appendChild(s); + } + } + + function inject() { + ensureStyle(); + + /* Topbar already in DOM — just sync state. */ + if (document.getElementById('utplsql-topbar')) { + updateActiveLink(); + applyStoredScheme(); + injectDrawerNav(); + return; + } + + /* Material's instant navigation removed the topbar — re-insert the same + DOM node so the CSS background-image icon doesn't flash. */ + if (savedBar) { + document.body.insertBefore(savedBar, document.body.firstChild); + updateActiveLink(); + applyStoredScheme(); + injectDrawerNav(); + return; + } + + /* ── First load: build the bar ── */ + var bar = document.createElement('nav'); + bar.id = 'utplsql-topbar'; + bar.setAttribute('aria-label', 'utPLSQL.org site navigation'); + + /* Hamburger — mobile only, triggers Material's sidebar drawer */ + var hamburger = document.createElement('button'); + hamburger.className = 'utplsql-hamburger'; + hamburger.setAttribute('aria-label', 'Open navigation'); + hamburger.innerHTML = SVG_MENU; + hamburger.addEventListener('click', function () { + var drawer = document.querySelector('label[for="__drawer"]'); + if (drawer) drawer.click(); + }); + bar.appendChild(hamburger); + + /* Brand */ + var brand = document.createElement('a'); + brand.className = 'utplsql-brand'; + brand.href = BASE + '/'; + + var icon = document.createElement('span'); + icon.className = 'utplsql-brand-icon'; + icon.setAttribute('aria-hidden', 'true'); + brand.appendChild(icon); + + var brandText = document.createElement('span'); + brandText.textContent = 'utPLSQL'; + brand.appendChild(brandText); + bar.appendChild(brand); + + /* Nav links */ + NAV.forEach(function (item) { + var a = document.createElement('a'); + a.href = item.url; + a.textContent = item.label; + bar.appendChild(a); + }); + + /* ── Right-aligned controls ── */ + var controls = document.createElement('div'); + controls.className = 'utplsql-controls'; + + /* Theme toggle — cycles: auto → light → dark → auto */ + themeBtn = document.createElement('button'); + themeBtn.addEventListener('click', function () { + var current = getPreference(); + var next = current === 'auto' ? 'default' : current === 'default' ? 'slate' : 'auto'; + try { localStorage.setItem('utplsql-scheme', next); } catch (e) {} + applyScheme(effectiveScheme(next)); + updateThemeIcon(); + }); + + updateThemeIcon(); + controls.appendChild(themeBtn); + bar.appendChild(controls); + + savedBar = bar; + document.body.insertBefore(bar, document.body.firstChild); + updateActiveLink(); + injectDrawerNav(); + + /* When auto mode is active, re-apply if the OS theme changes live. */ + window.matchMedia('(prefers-color-scheme: dark)').addEventListener('change', function () { + if (getPreference() === 'auto') { + applyScheme(effectiveScheme('auto')); + } + }); + } + + function rewriteFeedbackLink() { + var title = encodeURIComponent('Doc feedback: ' + document.title); + var body = encodeURIComponent('Page: ' + location.href + '\n\nWhat could be improved:\n'); + document.querySelectorAll('.md-feedback a[href*="discussions/new"]').forEach(function (a) { + a.href = 'https://github.com/utPLSQL/utPLSQL/discussions/new?category=documentation-feedback&title=' + title + '&body=' + body; + }); + } + + function initFeedbackForm() { + var feedback = document.forms.feedback; + if (typeof feedback === 'undefined') return; + + feedback.hidden = false; + feedback.addEventListener('submit', function (ev) { + ev.preventDefault(); + + var page = document.location.pathname; + var data = ev.submitter.getAttribute('data-md-value'); + + if (typeof gtag !== 'undefined') { + gtag('event', 'feedback', { page: page, data: data }); + } + + feedback.firstElementChild.disabled = true; + + var note = feedback.querySelector(".md-feedback__note [data-md-value='" + data + "']"); + if (note) note.hidden = false; + + rewriteFeedbackLink(); + }); + + rewriteFeedbackLink(); + } + + /* Hide Material's built-in header controls immediately to prevent a flash + where logo/palette appear before the topbar is painted. */ + ensureStyle(); + /* Fallback: if topbar not in DOM after 4 s, restore Material's navigation. */ + setTimeout(function () { + if (!document.getElementById('utplsql-topbar')) { + var s = document.getElementById('utplsql-topbar-style'); + if (s) s.parentNode.removeChild(s); + } + }, 4000); + + /* Apply initial scheme as early as possible to avoid flash. */ + applyScheme(effectiveScheme(getPreference())); + + if (document.readyState === 'loading') { + document.addEventListener('DOMContentLoaded', function () { inject(); initFeedbackForm(); }); + } else { + inject(); + initFeedbackForm(); + } + + /* Material instant navigation — fires after each page swap. */ + if (typeof document$ !== 'undefined') { + document$.subscribe(inject); + document$.subscribe(initFeedbackForm); + } + /* Fallback: browser history navigation */ + window.addEventListener('popstate', updateActiveLink); + +})(); diff --git a/docs/assets/utPLSQL-logo-transparent.png b/docs/assets/utPLSQL-logo-transparent.png new file mode 100644 index 00000000..e31eff24 Binary files /dev/null and b/docs/assets/utPLSQL-logo-transparent.png differ diff --git a/docs/assets/utPLSQL-testing-framework-transparent.png b/docs/assets/utPLSQL-testing-framework-transparent.png new file mode 100644 index 00000000..4bb19c6a Binary files /dev/null and b/docs/assets/utPLSQL-testing-framework-transparent.png differ diff --git a/docs/contributing.md b/docs/contributing.md new file mode 100644 index 00000000..06bfce4f --- /dev/null +++ b/docs/contributing.md @@ -0,0 +1,10 @@ +# Contributing + +The utPLSQL project team welcomes contributions from the community. + +- **Contribute code** — please read the [contributing guide](https://github.com/utPLSQL/utPLSQL/blob/develop/CONTRIBUTING.md) before submitting a pull request. +- **Ask questions and share ideas** — use [GitHub Discussions](https://github.com/orgs/utPLSQL/discussions) for support, questions, and feature proposals. +- **Support the project** — [sponsorship](sponsors.md) funds maintenance and development. +- **Report bugs and issues** — open an issue in the relevant [GitHub repository](index.md#frameworks-and-tools). + +The source code for all utPLSQL projects is hosted on the [utPLSQL GitHub organisation](https://github.com/utPLSQL). diff --git a/docs/documentation.md b/docs/documentation.md new file mode 100644 index 00000000..bbce1cb2 --- /dev/null +++ b/docs/documentation.md @@ -0,0 +1,13 @@ +--- +layout: page +title: Documentation +permalink: /documentation/ +menuInclude: true +--- + +* [utPLSQL framework](/utPLSQL/latest) +* [utPLSQL-cli](utPLSQL-cli.md) +* [utPLSQL-maven plugin](utPLSQL-maven-plugin.md) +* [SQLDeveloper extension](utPLSQL-SQLDeveloper.md) +* [PL/SQL Developer plugin](utPLSQL-PLSQL-Developer.md) + diff --git a/docs/downloads.md b/docs/downloads.md new file mode 100644 index 00000000..b927d38e --- /dev/null +++ b/docs/downloads.md @@ -0,0 +1,18 @@ +--- +layout: page +title: Downloads +permalink: /downloads/ +menuInclude: true +--- + + +- [utPLSQL framework](https://github.com/utPLSQL/utPLSQL/releases) - the testing framework + +- [utPLSQL-cli](https://github.com/utPLSQL/utPLSQL-cli/releases) - command line utility to run utPLSQL tests from any command line (Win/Linux/Mac) + +- [utPLSQL Maven plugin](https://github.com/utPLSQL/utPLSQL-maven-plugin/releases) to run utPLSQL tests as part of Java Maven project build + +- [utPSLQL - SQLDeveloper extension](https://github.com/utPLSQL/utPLSQL-SQLDeveloper/releases) to create and run utPLSQL tests from [SQLDeveloper](https://www.oracle.com/database/technologies/appdev/sql-developer.html) + +- [utPSLQL - PL/SQL Developer extension](https://github.com/utPLSQL/utPLSQL-PLSQL-Developer/releases) to create and run utPLSQL tests from [PLSQL Developer](https://www.allroundautomations.com/products/pl-sql-developer/) + diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 00000000..91b1c596 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,57 @@ +

utPLSQL - Testing Framework for PL/SQL

+ +

+ utPLSQL - Testing Framework for PL/SQL +
+ Sponsor utPLSQL +

+ +The ultimate unit testing framework for Oracle PL/SQL. + +Free, open-source, and inspired by the xUnit family (JUnit, NUnit, etc.). + +Write and run tests directly in PL/SQL, integrate with your CI/CD pipeline, and verify your code stability with every build. + +--- + +## Latest News + + + +[All announcements :octicons-arrow-right-24:](announcements/index.md) · [:material-rss: RSS feed](/feed_rss_created.xml) + +--- + +## Get Started + +- [Documentation](documentation.md) — installation, configuration, writing tests +- [Downloads](downloads.md) — latest releases and changelogs +- [Sponsorship](sponsors.md) — fund the maintenance and development of utPLSQL, or get commercial support + +--- + +## Frameworks and tools + +{% + include-markdown "https://raw.githubusercontent.com/utPLSQL/.github/main/profile/README.md" + rewrite-relative-urls=false + start="" + end="" +%} + +--- + +## Community + +Have a question or idea? Start a [discussion on GitHub](https://github.com/orgs/utPLSQL/discussions) — it's the best place to ask for help, share feedback, or propose new features. + +utPLSQL is free and open source, built by its community and stewarded by [utPLSQL Development Labs Ltd](about.md#stewardship). + +--- + +## Sponsors + +utPLSQL is free and open source (Apache 2.0). [Sponsorship](sponsors.md) funds development of new features and tools, maintaining compatibility with new Oracle versions and platforms, documentation. + + + diff --git a/docs/overrides/main.html b/docs/overrides/main.html new file mode 100644 index 00000000..58b36cce --- /dev/null +++ b/docs/overrides/main.html @@ -0,0 +1,27 @@ +{% extends "base.html" %} +{# + Org-site template override (utPLSQL.github.io). + Loads the same shared topbar as all sub-sites — single source of truth in topbar.js. +#} + +{% block extrahead %} + {{ super() }} + + +{% endblock %} diff --git a/docs/resources.md b/docs/resources.md new file mode 100644 index 00000000..f30f9a35 --- /dev/null +++ b/docs/resources.md @@ -0,0 +1,90 @@ +--- +layout: page +title: Resources +permalink: /resources/ +menuInclude: true +--- + +Do you know about videos, articles, blogs or code examples that are missing here? Please let us know! + +## Framework + +- [Latest documentation](/utPLSQL/latest/) + +#### Overview + +- [UKOUG Testing PLSQL APIs with utPLSQL v3 Webinar](https://www.youtube.com/watch?v=3IQXWdKkBP4) (by Jacek Gebal) + Comprehensive webinar about utPLSQL by Jacek Gebal. The definitive guide to why and how to test PL/SQL with utPLSQL +- [utPLSQL 3.0 - How to have your cake and eat it](https://mikesmithers.wordpress.com/2018/04/25/utplsql-3-0-how-to-have-your-cake-and-eat-it/) (by Mike Smithers) + Complete introduction to utPLSQL 3.0, covering installation, comprehensive example application, transaction challenges and even code coverage +- [Strongholds of Confidence: Self-Testing your Database](https://cleandatabase.wordpress.com/2017/10/26/strongholds-of-confidence-self-testing-your-database/) (by Samuel Nitsche) + Plea to start creating meaningful, automated self-tests and why. Finishes with a concrete utPLSQL example +- [Test Driven Development in PLSQL with utPLSQL v3 – intro](http://www.oraclethoughts.com/uncategorized/test-driven-development-in-oracle-database-with-utplsql-v3-intro/) (by Jacek Gebal) + Addresses some major struggles of developers who start with unit-testing and also gives a brief intro into Test-Driven-Development +- [Testing PL/SQL in your Ci/Cd pipeline with utPLSQL](https://www.youtube.com/watch?v=rgbAG8RgR9U) (by Blaine Carter) + Blaine demonstrates running utPLSQL unit tests in Oracle Developer Cloud and publishing test results. +- [Extending Oracle Database DevOps with Automated PL/SQL Unit Testing](https://www.youtube.com/watch?v=zFtUmAe61mg) (by Shay Shmeltzer) + Overview of running utPLSQL unit tests within Oracle Developer Cloud +- [DevOps Around Autonomous Data Warehouse](https://www.youtube.com/watch?v=AcWaYWAgOeQ) (Oracle) + A short overview of an architecture proposed for Database Software Delivery LifeCycle with automated testing and static code analysis +- [Oracle Developers Office Hours - Real World Testing of PL/SQL Code](https://www.youtube.com/watch?v=-GkzMV5lUaQ) (hosted by Steven Feuerstein) + Panel webinar with: Jasmin Fluri, Deepthi Bandari, Swathi Ambati & Maik Becker, Patrick Barel & Samuel Nitsche +- [Oracle Groundbreakers - Testing with utPLSQL](https://www.youtube.com/watch?v=OxHMaOiPitI) (by Philipp Salvisberg) + Presentation on 28th October 2020 at Oracle Groundbreakers APAC Virtual Tour +- [Oracle Developers Office Hours - Testing with utPLSQL](https://www.youtube.com/watch?v=5WGHplRgXzQ) (hosted by Connor McDonald) + Live coding and testing session with Samuel Nitsche and Jacek Gebal +- [Testing in the Imperial Database](https://www.youtube.com/watch?v=sDI8FwKzdok) (by Samuel Nitsche) + Talk from SAST Q4 Digital Testing conference +- [Testing With utPLSQL – Made Easy With SQL Developer](https://www.salvis.com/blog/2022/07/31/testing-with-utplsql-made-easy-with-sql-developer/) (by Philipp Salvisberg) +- [Database Development Champions - Programming With utPLSQL – This Is the Way](https://www.youtube.com/watch?v=LtypQEr4-5A) (by Philipp Salvisberg) + +#### Structuring Tests + +- [utPLSQL’s Suite Hierarchy in action](https://cleandatabase.wordpress.com/2018/12/16/100codeexamples-utplsqls-suite-hierarchy-in-action/) (by Samuel Nitsche) + Example of the `%suitepath` annotation and utPLSQL hierarchies +- [Narrate Star Wars Movies with utPLSQL annotations](https://cleandatabase.wordpress.com/2019/06/25/narrate-star-wars-movies-with-utplsql-annotations/) (by Samuel Nitsche) + Example how to use the different annotations that allow to structure tests (`%before`, `%after`, `%context`) +- [Testing the Deathstar security with utPLSQL contexts](https://cleandatabase.wordpress.com/2019/06/06/testing-the-deathstar-security-with-utplsql-contexts/) (by Samuel Nitsche) + Example how to use the `%context` annotation + +#### Cursor Comparison + +- [What is the equivalent of utassert eqtable / eqquery in utPLSQL v3](http://www.oraclethoughts.com/utplsql/what-is-the-equivalent-of-utassert-eqtable-utplsql-v2-v3/) (by Jacek Gebal) + Comparison between utPLSQL v2's `utassert.eqtable` and v3's `ut.expect(sys_refcursor).to_equal(sys_refcursor)` approach. +- [Unit-Tests for Primary/Secondary Lookup with Cursor Comparison](https://cleandatabase.wordpress.com/2018/12/06/100codeexamples-unit-tests-for-primary-secondary-lookup-with-cursor-comparison/) (by Samuel Nitsche) + Example how to use cursor comparison with `select from dual` expectations +- [utPLSQL Cursor Comparison with user-defined Types](https://cleandatabase.wordpress.com/2019/02/03/100codeexamples-utplsql-cursor-comparison-with-user-defined-types/) (by Samuel Nitsche) + Example how to use cursor comparison with expectations created via user-defined types +- [Test updatable views with utPLSQL Cursors](https://cleandatabase.wordpress.com/2019/03/15/100codeexamples-test-updatable-views-with-utplsql-cursors/) (by Samuel Nitsche) + Example how to easily test the updatability of a view with cursor comparison + +#### Code Talks + +- [2017 CodeTalk Series: Unit Testing PL SQL Code in the Real World](https://www.youtube.com/watch?v=1qAZvS5rvyY) +- [2018 CodeTalk Series: Practical Advice for Taking Your PL SQL Testing to the Next Level](https://www.youtube.com/watch?v=CvZOwp9pn4o) + + +## Tools + +#### utPLSQL - SQLDeveloper extension + +- [Running utPLSQL Tests in SQL Developer](https://www.salvis.com/blog/2019/07/06/running-utplsql-tests-in-sql-developer/) (by Philipp Salvisberg) + Detailed explanation how to install and use the utPLSQL-Plugin for SQLDeveloper +- [utPLSQL for SQL Developer 1.2 – What’s New?](https://www.salvis.com/blog/2020/06/07/utplsql-for-sql-developer-1-2-whats-new/) (by Philipp Salvisberg) +- [Documentation](https://github.com/utPLSQL/utPLSQL-SQLDeveloper) +- [Downloads](https://github.com/utPLSQL/utPLSQL-SQLDeveloper/releases) + +#### utPLSQL Command-line interface + +- [Documentation](https://github.com/utPLSQL/utPLSQL-cli) +- [Downloads](https://github.com/utPLSQL/utPLSQL-cli/releases) + +#### utPLSQL PLSQL-Developer plugin + +- [Documentation](https://github.com/utPLSQL/utPLSQL-PLSQL-Developer) +- [Download](https://github.com/utPLSQL/utPLSQL-PLSQL-Developer/releases) + +#### Maven-Plugin + +- [Documentation](https://github.com/utPLSQL/utPLSQL-maven-plugin) + diff --git a/docs/sponsors.md b/docs/sponsors.md new file mode 100644 index 00000000..d5961c01 --- /dev/null +++ b/docs/sponsors.md @@ -0,0 +1,35 @@ +--- +description: "The organizations and individuals who fund the maintenance and development of utPLSQL." +--- + +# Our sponsors + +utPLSQL is free and open source, built by its maintainers and contributors. Its maintenance and development are funded by the organizations and individuals listed here. Thank you. + +**Want to be listed?** + +[Become a sponsor](sponsorship.md){ .md-button .md-button--primary } + +## Commercial support sponsors + + +There are currently no commercial support sponsors. + + +## Organization sponsors + + +There are currently no organization sponsors. + + +## Individual supporters + +Individuals who sponsor publicly are shown on the [utPLSQL GitHub Sponsors page](https://github.com/sponsors/utPLSQL). + +## Past sponsors + + + +A complete list of all current and past sponsors is kept in [`SPONSORS.md`](https://github.com/utPLSQL/utPLSQL/blob/develop/SPONSORS.md) in the utPLSQL repository. diff --git a/docs/sponsorship.md b/docs/sponsorship.md new file mode 100644 index 00000000..08c6783e --- /dev/null +++ b/docs/sponsorship.md @@ -0,0 +1,256 @@ +--- +description: "Become a sponsor of utPLSQL: recognition tiers for organizations, commercial support, consulting, and individual sponsorship. utPLSQL stays free and open source." +--- + +# Sponsorship + +Sponsorship secures financing needed to keep utPLSQL projects under active development in a sustainable, predictable fashion. +In particular, it covers the following activities: + +- providing necessary updates and patches to keep utPLSQL products a relevant and valuable tool for Oracle database software development +- design and development of new functionalities, tools and features that will enable more rapid, reliable and thorough testing of Oracle PL/SQL and Oracle database solutions in general +- ensuring compatibility with currently supported Oracle database versions and new versions of languages and platforms that are continuously evolving +- providing thorough and current documentation related to installation, configuration and usage of the frameworks and tools +- maintaining the hosting of the project, its documentation, social media accounts, interacting with users, providing open and public information about the project, database testing and testing strategies in general +- triaging and responding to questions and issues raised by users through various channels, providing fixes for identified bugs + +utPLSQL is free to use and open-source, licensed under Apache 2.0, and stays that way. Sponsorship funds the development; it does not grant access to the product. + +## Why sponsor the project + +If your business is using utPLSQL to test and verify the quality of your database software, you are most likely benefiting from all the functionality it brings to the test automation. Even if you are using AI to generate the portfolio of test-suites for your project, those tests depend on the stability and availability of utPLSQL. Oracle releases new database versions regularly. CI platforms change their reporting formats. Client tools update. New platforms and tools show up on the landscape. +To keep your test automation working and relevant, utPLSQL framework and its tools need to be continuously developed and updated. +Without sponsorship, providing timely and reliable support for the framework is not feasible and sustainable. + +The framework and tooling needs to grow to continuously enable faster and easier test implementation and execution. There is a backlog of features that today sit in open discussions and would improve the framework's functionality. Those need design and development time to be delivered. + +Sponsorship allows for both. Providing supportability and stability to existing tooling and growing the tooling and feature ecosystem. +It provides the necessary funding to keep the project sustainable, keeps utPLSQL current with the platforms you deploy on, and gives the maintainers the capacity to deliver the roadmap at a steady rate. + +--- + +## How to sponsor + +Sponsorship goes through one of two routes: [GitHub Sponsors](https://github.com/sponsors/utPLSQL), or a direct agreement with utPLSQL Development Labs Ltd, invoiced and paid by bank transfer. Which one applies depends on what you choose: + +| You want to | Via GitHub Sponsors | Via direct invoice | +|---------------------------------------------------------------------------------------------------|--------------------------|----------------------------------| +| Support the project as an [individual](#individual-supporters), any amount | yes, one-time or monthly | - | +| Sponsor at [100 EUR / month](#organization-sponsor-at-100-eur-month) | yes, monthly | yes, annual invoice of 1,200 EUR | +| Sponsor at [250 EUR / month](#organization-sponsor-at-250-eur-month) | yes, monthly | yes, annual invoice of 3,000 EUR | +| Sponsor at [500 EUR / month](#organization-sponsor-at-500-eur-month) | yes, monthly | yes, annual invoice of 6,000 EUR | +| Get [commercial support](#commercial-support) | - | yes, annual invoice | +| Engage us for [consulting, training or problem-solving](#consulting-training-and-problem-solving) | - | yes, invoice per engagement | + +Direct invoicing starts with an email to [sponsors@utPLSQL.org](mailto:sponsors@utPLSQL.org). Bank details are provided on the invoice only. + +Sponsorship through GitHub funds the project and gives recognition. It does not include support or consultation, which are contracted directly. + +--- + +## Individual supporters + +utPLSQL framework is an open-source initiative. If you find it useful, you can express your gratitude to those who keep the project running. +Your sponsorship supports the continued development of the project. + +**Any amount, one-time or monthly.** Choose what suits you. + +What you get is our gratitude and thanks for appreciation of the project. Your sponsorship will be visible to others through the normal channels provided by the GitHub platform, that is: + +- a sponsor badge on your own GitHub profile +- your name and avatar shown on the [utPLSQL GitHub Sponsors page](https://github.com/sponsors/utPLSQL), unless you choose to sponsor privately + +!!! info "Individual supporters" + Sponsorship is paid through [GitHub Sponsors](https://github.com/sponsors/utPLSQL). + +---- + +## Organization sponsors + +Your company is using utPLSQL for quality assurance of your critical systems? Your test suites saved you several times from a fatal or disastrous incident in production? You rely on utPLSQL in your day-to-day work and want to make sure it will remain actively maintained and developed? +These tiers help us fund the maintenance and development. +Your company will be listed as a sponsor. + +Organization sponsorship is paid monthly through [GitHub Sponsors](https://github.com/sponsors/utPLSQL). The sponsoring organization gets recognition on our pages. +If you need support or a maintenance commitment, see [Commercial support](#commercial-support). + +!!! info "Organization Sponsors" + Sponsorship is paid through [GitHub Sponsors](https://github.com/sponsors/utPLSQL), or directly by invoice: write to [sponsors@utPLSQL.org](mailto:sponsors@utPLSQL.org), and utPLSQL Development Labs Ltd issues an annual invoice of 6,000 EUR, paid by bank transfer. + +### Organization Sponsor at 100 EUR / month + +Everything an [individual supporter](#individual-supporters) gets (a sponsor badge on your GitHub profile and your name and avatar on the utPLSQL GitHub Sponsors page), plus: + +- Company name on the [sponsors page](sponsors.md) of utplsql.org +- Backlink to your website + +### Organization Sponsor at 250 EUR / month + +Everything an [individual supporter](#individual-supporters) gets (a sponsor badge on your GitHub profile and your name and avatar on the utPLSQL GitHub Sponsors page), plus: + +- Small logo on the [sponsors page](sponsors.md) of utplsql.org +- Small logo on the utPLSQL organization profile on GitHub +- Backlink to your website from both placements + + +### Organization Sponsor at 500 EUR / month + +Everything an [individual supporter](#individual-supporters) gets (a sponsor badge on your GitHub profile and your name and avatar on the utPLSQL GitHub Sponsors page), plus: + +- Large logo on the [sponsors page](sponsors.md) of utplsql.org +- Large logo on the utPLSQL organization profile on GitHub +- Large logo in the sponsors block of the utPLSQL framework README +- Large logo on the utplsql.org landing page +- Backlink to your website from every placement +- Announcement of your sponsorship on the utPLSQL [LinkedIn](https://www.linkedin.com/company/utplsql/), [X](https://x.com/utPLSQL) and [Bluesky](https://bsky.app/profile/utplsql.org) accounts +- Quarterly written project update: what has shipped, what is in progress, and what is planned next + +--- + +## Commercial support + +These tiers include private consultation time, priority issue triage, and notification of upcoming features and changes. + +They do not confer any control over the direction of utPLSQL. Decisions about the roadmap, about design, and about what is accepted into the codebase rest with the maintainers, for sponsors and non-sponsors alike. What you are buying is maintainer capacity and access, not influence. + +Commercial support is deliberately limited. We currently accept a maximum of 15 organizations at a time, and no more than 48 contracted consultation hours per month in total, so that the majority of funded time goes into developing utPLSQL rather than into supporting individual users. As the team grows we will raise these limits and say so here. When all places are taken, we keep a waiting list. + +Agreements are made with [utPLSQL Development Labs Ltd](announcements/incorporation-of-utplsql-development-labs-ltd.html), the company incorporated in Cyprus to act as custodian of the project, which holds the utPLSQL name, branding and project assets. The work is delivered by the project's maintainers. + +Commercial support is not paid through GitHub Sponsors. It is contracted and invoiced directly: + +1. Write to [sponsors@utPLSQL.org](mailto:sponsors@utPLSQL.org) with the tier you are interested in and a short description of your needs. +2. We confirm availability (see the limits above) and agree scope and term with you. +3. We send the agreement. Once it is accepted, the Ltd issues an annual invoice with its bank details. +4. You pay by bank transfer, and the support period starts on receipt of payment. + +!!! info "Commercial support" + Sponsorship is paid through direct invoicing contact [sponsors@utPLSQL.org](mailto:sponsors@utPLSQL.org). + +### Maintenance Support — 1,000 EUR / month + +12,000 EUR per year. + +- 2 hours per month of private consultation with a maintainer, by video call or asynchronously. Unused hours expire at the end of each calendar quarter. +- Priority triage on issues you raise: acknowledged promptly, with an assessment and a workaround where one exists +- Announcement of your sponsorship on the utPLSQL [LinkedIn](https://www.linkedin.com/company/utplsql/), [X](https://x.com/utPLSQL) and [Bluesky](https://bsky.app/profile/utplsql.org) accounts +- A named contact and a private communication channel +- Advance notice of new features and changes coming into the next releases +- Quarterly written project update: what has shipped, what is in progress, and what is planned next +- Large logo in the commercial sponsors block, listed above the recognition sponsors, on every surface where sponsors appear, with a backlink to your website + +### Extended Support — 2,500 EUR / month + +30,000 EUR per year. + +Everything in Maintenance Support, with: + +- 8 hours per month of private consultation instead of 2, by video call or asynchronously. Unused hours expire at the end of each calendar quarter. + +### How the price is built + +Both tiers are priced the same way: 500 EUR per month for the ongoing relationship, which covers priority triage, the named contact and private channel, advance notice of changes, and sponsor recognition, plus 250 EUR for each contracted consultation hour. + +- Maintenance Support: 500 + (2 x 250) = 1,000 EUR / month +- Extended Support: 500 + (8 x 250) = 2,500 EUR / month + +--- + +## Consulting, training and problem-solving + +Outside the support tiers, we take on individual engagements: + +- consulting on test strategy, test suite structure and CI/CD integration +- training for teams adopting utPLSQL, or scaling an existing suite +- investigation of specific problems: failing or flaky suites, slow execution, migration between utPLSQL or Oracle versions + +Each engagement is scoped and quoted on its own. Contact +[sponsors@utPLSQL.org](mailto:sponsors@utPLSQL.org) describing what you need and +we will tell you whether we can help and what it would take. Accepted engagements are agreed in writing and invoiced by utPLSQL Development Labs Ltd, payable by bank transfer. + +If what you need is a change in utPLSQL itself, mention it in the same message. Where it fits the direction of the project, we can agree a scope, a price and a delivery window. +The result is designed and reviewed by the maintainers and released under Apache 2.0 like everything else, so you carry no fork and no maintenance burden afterwards. + +--- + +## Recognition at a glance + +| Placement | 100 | 250 | 500 | Commercial support | +|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----|-------|-------|--------------------| +| Company name as text on the [sponsors page](sponsors.md) of utplsql.org | yes | - | - | - | +| Backlink to your website from every placement | yes | yes | yes | yes | +| Logo on the [sponsors page](sponsors.md) of utplsql.org | - | small | large | large | +| Logo on the utPLSQL GitHub organization profile | - | small | large | large | +| Logo in the utPLSQL framework README | - | - | large | large | +| Logo on the utplsql.org landing page | - | - | large | large | +| Company name as logo tooltip | - | yes | yes | yes | +| Announcement on the utPLSQL social channels ([LinkedIn](https://www.linkedin.com/company/utplsql/), [X](https://x.com/utPLSQL), [Bluesky](https://bsky.app/profile/utplsql.org)) | - | - | yes | yes | +| Quarterly written project update | - | - | yes | yes | +| Listed in the commercial sponsors block, above recognition sponsors | - | - | - | yes | + +Where a logo is shown, it links to your website, and your company name appears as a tooltip when hovering over the logo. The company name is not printed next to the logo. Small logos are displayed in a box of up to 64 pixels height and 192 pixels width, large logos in a box of up to 128 pixels height and 384 pixels width (3:1). A logo wider than its box is scaled down to fit, keeping its proportions. We ask +for SVG, with separate light and dark variants where your logo needs them. If you can only supply a PNG, please send it at least 256 pixels high or 768 pixels wide, whichever limit the logo reaches first; larger is welcome. + +A complete list of all current and past sponsors is kept in [`SPONSORS.md`](https://github.com/utPLSQL/utPLSQL/blob/develop/SPONSORS.md) in the utPLSQL repository. + +--- + +## Questions + +**Does sponsorship include support?** +Not at the recognition tiers. Those fund the project and list your organization +as a sponsor. Support, consultation and response commitments start at the +commercial support tiers. + +**Who receives the money?** +utPLSQL Development Labs Ltd, the custodian of the project. It contracts with sponsors, and allocates the +funds to maintainer time, infrastructure, and development work on the project's +repositories. + +**Can we pay annually by invoice?** +Yes, for commercial support tiers, which are invoiced annually by utPLSQL Development Labs +Ltd and paid by bank transfer. Recognition tiers are paid monthly through [GitHub Sponsors](https://github.com/sponsors/utPLSQL); organizations can also switch to invoiced +billing with GitHub directly. + +**Where can I find your bank details?** +On the invoice. We do not publish bank details on this site. If you receive payment details by any other route, please confirm them with [sponsors@utPLSQL.org](mailto:sponsors@utPLSQL.org) before paying. + +**What happens to unused consultation hours?** +Hours accrue within a calendar quarter and expire at the end of it. + +**What does consultation cover?** +utPLSQL usage, test design, CI/CD integration, migration between versions, and +coverage reporting. It does not cover general PL/SQL development or debugging +of your application code. + +**Does sponsorship influence the roadmap?** +No. The roadmap, the design of the framework, and the decision on what is accepted into the codebase are set by the maintainers and are not for sale at any tier. Sponsorship funds the capacity to deliver that roadmap; it does not reorder it. + +**Can we pay to have our issue prioritised?** +Yes, that is what priority triage in the commercial support tiers is for. Your issue is acknowledged and assessed promptly, with a workaround where one exists, and our maintainers will work on resolving your problem as soon as possible. + +**Can we sponsor a specific feature?** +Possibly. Describe what you need, and we will tell you whether it fits the +direction of the project. Where it does, we agree a scope, a price and a +delivery window as a separate engagement. The work is designed and reviewed by +the maintainers, released under Apache 2.0 like the rest of the project, and +available to everyone. Where it does not fit, we will say so and decline rather +than take the work. + +**How do we cancel?** +Recognition tiers are month to month with no notice period. Commercial support tiers run +for the agreed term with 30 days notice, because they commit maintainer +capacity. + +**What happens when we stop sponsoring?** +Your logo and name are removed from the utPLSQL GitHub organization profile, the framework README and the utplsql.org landing page at the end of the period you paid for, plus a 30-day grace period for failed payments and renewals. If you sponsored for at least three months, or under a commercial support agreement, your logo then moves to the Past sponsors section of the [Our sponsors](sponsors.md) page, shown faded and without further detail. You can ask us to remove it at any time. [`SPONSORS.md`](https://github.com/utPLSQL/utPLSQL/blob/develop/SPONSORS.md) keeps a permanent archive of sponsor names and years. + +--- + +## Contact + +[sponsors@utPLSQL.org](mailto:sponsors@utPLSQL.org) + +Follow the project on [LinkedIn](https://www.linkedin.com/company/utplsql/), [X](https://x.com/utPLSQL) and [Bluesky](https://bsky.app/profile/utplsql.org). + +utPLSQL Development Labs Ltd, Cyprus. Custodian of the utPLSQL project. diff --git a/docs/stylesheets/extra.css b/docs/stylesheets/extra.css new file mode 100644 index 00000000..56bb483a --- /dev/null +++ b/docs/stylesheets/extra.css @@ -0,0 +1,169 @@ +[data-md-color-scheme="default"] { + --md-primary-fg-color: #1565c0; /* link + header colour: 5.8:1 with white text */ + --md-typeset-a-color: #1565c0; /* link = header colour: 5.8:1 */ + --md-accent-fg-color: #1e88e5; /* hover: lighter than the link, 3.7:1 */ + --md-accent-fg-color--transparent: rgba(30, 136, 229, .1); + --md-default-fg-color--light: hsla(0, 0%, 0%, .64); /* muted text 6.7:1 */ +} + +[data-md-color-scheme="slate"] { + --md-hue: 215; + --md-primary-fg-color: #1565c0; /* header background keeps the brand blue */ + --md-accent-fg-color: #3578cc; /* hover: darker than the link, 3.6:1 */ + --md-accent-fg-color--transparent: rgba(53, 120, 204, .1); + --md-default-fg-color: hsla(var(--md-hue), 15%, 90%, .90); /* body ~10:1 */ + --md-default-fg-color--light: hsla(var(--md-hue), 15%, 90%, .68); /* muted 6.5:1 */ + --md-code-hl-keyword-color: hsl(219, 80%, 72%); +} + +/* Material sets the dark link colour per primary colour with higher specificity */ +[data-md-color-scheme="slate"][data-md-color-primary] { + --md-typeset-a-color: #4a90e2; /* link: header blue lightened just enough to read on dark, 4.8:1 */ +} + +/* Latest news cards on the home page (generated by hooks/latest_posts.py) */ +.latest-posts > ul > li { + position: relative; + display: flex; + flex-direction: column; +} + +/* Stretch the title link over the whole card */ +.latest-posts > ul > li strong a::after { + content: ""; + position: absolute; + inset: 0; +} + +.latest-posts__meta { + display: block; + font-size: .7rem; + color: var(--md-default-fg-color--light); +} + +.latest-posts__more { + margin-top: auto; + font-size: .7rem; + color: var(--md-typeset-a-color); +} + + + +/* Material's pin badge (md-pin) is a flex item on the Announcements page - align it inline here */ +.latest-posts__meta .md-pin { + display: inline-block; + vertical-align: middle; +} + +/* Sponsor logo grids (sponsors.md). Logo boxes have a 3:1 maximum aspect ratio: small 64 px high / max 192 px + wide, large 128 px high / max 384 px wide, clear space 16 / 32 px. A logo wider than its box is scaled down + to fit, keeping its aspect ratio (object-fit: contain). Past sponsors use the small box, grayscale and faded. */ +.sponsor-grid { + display: flex; + flex-wrap: wrap; + align-items: center; + gap: .5rem 1rem; + margin: 1rem 0 1.5rem; +} + +.sponsor-grid > p { + margin: 0; +} + +.sponsor-grid a { + display: inline-block; +} + +.sponsor-grid img { + display: block; + width: auto; + object-fit: contain; +} + +.sponsor-grid--large a { + padding: 32px; +} + +.sponsor-grid--large img { + height: 128px; + max-width: 384px; +} + +.sponsor-grid--small a { + padding: 16px; +} + +.sponsor-grid--small img { + height: 64px; + max-width: 192px; +} + +.sponsor-grid--past a { + padding: 16px; +} + +.sponsor-grid--past img { + height: 64px; + max-width: 192px; + filter: grayscale(100%); + opacity: .55; +} + +.sponsor-grid--text { + gap: .25rem 1.5rem; +} + +/* Sponsors who supply separate light and dark logos: add .logo-light / .logo-dark to the images */ +.logo-dark { + display: none !important; +} + +[data-md-color-scheme="slate"] .logo-light { + display: none !important; +} + +[data-md-color-scheme="slate"] .logo-dark { + display: block !important; +} + +/* Footer: make the sponsor and cookie links stand out from the copyright text */ +.md-copyright a.footer-sponsor { + display: inline-flex; + overflow: hidden; + margin: 0 .4rem; + font-size: .65rem; + font-weight: 600; + line-height: 1; + color: #fff; + text-decoration: none; + vertical-align: middle; + border-radius: .2rem; +} + +.footer-sponsor__label, +.footer-sponsor__name { + padding: .3rem .5rem; +} + +.footer-sponsor__label { + background: #555; +} + +.footer-sponsor__name { + background: #ea4aaa; +} + +.md-copyright a.footer-sponsor:hover { + color: #fff; + opacity: .85; +} + +.md-copyright a.footer-cookies { + color: var(--md-footer-fg-color); + text-decoration: underline; + text-underline-offset: .15em; +} + +.md-copyright a.footer-cookies:hover { + color: var(--md-accent-fg-color); +} diff --git a/docs/utPLSQL-PLSQL-Developer.md b/docs/utPLSQL-PLSQL-Developer.md new file mode 100644 index 00000000..54a59e13 --- /dev/null +++ b/docs/utPLSQL-PLSQL-Developer.md @@ -0,0 +1,8 @@ +--- +title: utPLSQL-PLSQL-Developer plugin +--- + +{% + include-markdown "https://raw.githubusercontent.com/utPLSQL/utPLSQL-PLSQL-Developer/develop/README.md" + rewrite-relative-urls=false +%} diff --git a/docs/utPLSQL-SQLDeveloper.md b/docs/utPLSQL-SQLDeveloper.md new file mode 100644 index 00000000..c26663c2 --- /dev/null +++ b/docs/utPLSQL-SQLDeveloper.md @@ -0,0 +1,8 @@ +--- +title: utPLSQL-SQLDeveloper extension +--- + +{% + include-markdown "https://raw.githubusercontent.com/utPLSQL/utPLSQL-SQLDeveloper/main/README.md" + rewrite-relative-urls=false +%} diff --git a/docs/utPLSQL-cli.md b/docs/utPLSQL-cli.md new file mode 100644 index 00000000..22f95c49 --- /dev/null +++ b/docs/utPLSQL-cli.md @@ -0,0 +1,9 @@ +--- +title: utPLSQL-cli +--- + +{% + include-markdown "https://raw.githubusercontent.com/utPLSQL/utPLSQL-cli/develop/README.md" + rewrite-relative-urls=true + start="# utPLSQL-cli" +%} diff --git a/docs/utPLSQL-maven-plugin.md b/docs/utPLSQL-maven-plugin.md new file mode 100644 index 00000000..378285e6 --- /dev/null +++ b/docs/utPLSQL-maven-plugin.md @@ -0,0 +1,9 @@ +--- +title: utPLSQL-maven plugin +--- + +{% + include-markdown "https://raw.githubusercontent.com/utPLSQL/utPLSQL-maven-plugin/develop/README.md" + rewrite-relative-urls=true + start="# utPLSQL-maven-plugin" +%} diff --git a/documenation.md b/documenation.md deleted file mode 100644 index c9eeefbd..00000000 --- a/documenation.md +++ /dev/null @@ -1,10 +0,0 @@ ---- -layout: page -title: Documentation -permalink: /documentation/ ---- - -We automatically publish the documentation of utPLSQL development branch with every build. -Each downloadable release also contains a "docs" folder with complete documentation for that release. - -**Latest documentation and documentation for individual versions is available [here](/utPLSQL/)** diff --git a/downloads.md b/downloads.md deleted file mode 100644 index bceadd9b..00000000 --- a/downloads.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -layout: page -title: Downloads -permalink: /downloads/ ---- - -[Latest Release](https://github.com/utPLSQL/utPLSQL/releases/latest) - -Older releases can be found on our [releases page](https://github.com/utPLSQL/utPLSQL/releases). - -You can find the latest source code for [utPLSQL on GitHub](https://github.com/utplsql/utplsql) diff --git a/feed.xml b/feed.xml deleted file mode 100644 index a6628bd8..00000000 --- a/feed.xml +++ /dev/null @@ -1,30 +0,0 @@ ---- -layout: null ---- - - - - {{ site.title | xml_escape }} - {{ site.description | xml_escape }} - {{ site.url }}{{ site.baseurl }}/ - - {{ site.time | date_to_rfc822 }} - {{ site.time | date_to_rfc822 }} - Jekyll v{{ jekyll.version }} - {% for post in site.posts limit:10 %} - - {{ post.title | xml_escape }} - {{ post.content | xml_escape }} - {{ post.date | date_to_rfc822 }} - {{ post.url | prepend: site.baseurl | prepend: site.url }} - {{ post.url | prepend: site.baseurl | prepend: site.url }} - {% for tag in post.tags %} - {{ tag | xml_escape }} - {% endfor %} - {% for cat in post.categories %} - {{ cat | xml_escape }} - {% endfor %} - - {% endfor %} - - diff --git a/hooks/latest_posts.py b/hooks/latest_posts.py new file mode 100644 index 00000000..eab839eb --- /dev/null +++ b/hooks/latest_posts.py @@ -0,0 +1,139 @@ +""" +Renders the most recent announcements as Material grid cards. + +Replaces the `` placeholder in any page with cards for +pinned posts (`pin: true`) followed by the newest ones, as ordered by the +blog plugin. + +Card text is, in order of preference: + 1. the post's `description:` front matter, + 2. the first paragraph before the first list (e.g. an intro above `## What's Changed`), + 3. the list items (release notes), without author, PR and issue references. + +Posts without a `description:` also get the generated summary as their +`` and RSS feed item description. +""" +import posixpath +import re + +from material.plugins.blog.structure import Post + +PLACEHOLDER = "" +COUNT = 4 +SUMMARY_LENGTH = 180 + +ICONS = { + "releases": ":material-rocket-launch-outline:", + "news": ":material-newspaper-variant-outline:", + "website": ":material-web:", + "tips-n-tricks": ":material-lightbulb-on-outline:", +} +DEFAULT_ICON = ":material-bullhorn-outline:" + +LINK = re.compile(r"\[([^\]]*)\]\([^)]*\)") +LIST_ITEM = re.compile(r"^\s*[*+-]\s+(.*)$", re.MULTILINE) +# Setext headings - a line underlined with --- or === +SETEXT_HEADING = re.compile(r"^.+\n[-=]{3,}\s*$", re.MULTILINE) +# Lines that are not prose: headings, lists, tables, HTML, code, rules, +# "**Label**: ..." lines (e.g. Full Changelog), link-only lines (e.g. Download) and bare URLs +NOT_PROSE = re.compile(r"^(#|<|!|\||`|[*+-] |---|\*\*[^*]+\*\*:|\[[^\]]*\]\([^)]*\)$|https?://\S+$)") +# Trailing references of a release note item, e.g. " by @user in [#1](...)", +# ". Fixed in [#1](...), resolves [#2](...)", " ([#1](...))", " #1" or ". See [documentation](...)" +REFERENCES = re.compile( + r"(\s+(by\s+\[?@\S+|\[?@\S+\s+in\s+\[#).*" + r"|\.?\s+(Fixed|Implemented)\s+in\b.*" + r"|[\s,]+-?\s*resolves\s+\[?#.*" + r"|\.?\s+See\s+\[[^\]]*\]\([^)]*\)" + r"|[\s,(]+\[#\d+\]\([^)]*\)\)?" + r"|\s+#\d+)$", + re.IGNORECASE, +) + + +def on_page_markdown(markdown, page, config, files): + # Set before the page is rendered, so the RSS plugin picks it up as well + if isinstance(page, Post) and not page.meta.get("description"): + summary = _summary(page) + if summary: + page.meta["description"] = re.sub(r"`|\*\*", "", summary) + page.meta["description_generated"] = True + if PLACEHOLDER not in markdown: + return markdown + blog = config.plugins["material/blog"].blog + posts = [post for post in blog.posts if not post.config.draft][:COUNT] + base = posixpath.dirname(page.file.src_uri) + cards = "\n".join(_card(post, posixpath.relpath(post.file.src_uri, base or ".")) for post in posts) + html = f'
\n\n{cards}\n
' + return markdown.replace(PLACEHOLDER, html) + + +def _card(post, link): + categories = post.config.categories + icon = next((ICONS[c] for c in categories if c in ICONS), DEFAULT_ICON) + created = post.config.date.created + date = f"{created:%B} {created.day}, {created.year}" + # Same pin badge as on the Announcements page (Material's `md-pin`) + pin = ' · ' if post.config.pin else "" + return ( + f"- {icon}{{ .lg .middle }} __[{post.meta['title']}]({link})__\n\n" + f" ---\n\n" + f' {pin}{date} · {" · ".join(categories)}\n\n' + f" {_summary(post)}\n\n" + f' Read more :octicons-arrow-right-24:\n' + ) + + +def _summary(post): + # A generated description is plain text - rebuild it, so cards keep code formatting + if post.meta.get("description") and not post.meta.get("description_generated"): + return _truncate(_plain(post.meta["description"])) + body = SETEXT_HEADING.sub("", post.markdown) + first_item = LIST_ITEM.search(body) + intro = _first_paragraph(body[:first_item.start()] if first_item else body) + if intro: + return _truncate(_plain(intro)) + return _changes(body) + + +def _first_paragraph(markdown): + # First run of prose lines + lines = [] + for line in markdown.splitlines(): + line = line.strip() + if line and not NOT_PROSE.match(line): + lines.append(line) + elif lines: + break + return " ".join(lines) + + +def _changes(markdown): + # Release note items joined into one line, e.g. "Fix A · Add B · +3 more" + items = [_item(match.group(1)) for match in LIST_ITEM.finditer(markdown)] + items = [item for item in items if item and not item.startswith("#")] + summary = "" + for count, item in enumerate(items): + more = f" · +{len(items) - count} more" + candidate = f"{summary} · {item}" if summary else item + if summary and len(candidate) + len(more) > SUMMARY_LENGTH: + return summary + more + summary = candidate + return _truncate(summary) + + +def _item(text): + previous = None + while previous != text: + previous, text = text, REFERENCES.sub("", text.strip()) + return _plain(text).rstrip(" .,") + + +def _plain(text): + text = LINK.sub(r"\1", text) + return re.sub(r"\s+", " ", text).strip() + + +def _truncate(text): + if len(text) > SUMMARY_LENGTH: + text = text[:SUMMARY_LENGTH].rsplit(" ", 1)[0].rstrip(",.;:") + "…" + return text diff --git a/index.html b/index.html deleted file mode 100644 index 05cf033f..00000000 --- a/index.html +++ /dev/null @@ -1,25 +0,0 @@ ---- -layout: default ---- - -
- -

Announcements

- - - -

subscribe via RSS

- -
diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 00000000..4471ec52 --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,168 @@ +# Format documented here +# http://www.mkdocs.org/user-guide/configuration/ +# https://squidfunk.github.io/mkdocs-material/getting-started/ + +site_url: https://www.utplsql.org/ +site_name: utPLSQL +remote_branch: mkdocs_site +remote_name: origin +site_description: utPLSQL Ultimate Testing Framework for Oracle PL/SQL +copyright: > + Copyright © 2016 - 2026 utPLSQL Project. + Stewarded by utPLSQL Development Labs Ltd. + ♡ SponsorutPLSQL + Change cookie settings +extra_css: + - assets/topbar.css + - stylesheets/extra.css +theme: + name: material + custom_dir: docs/overrides + palette: + # Palette toggle for light mode + - media: "(prefers-color-scheme: light)" + scheme: default + toggle: + icon: material/lightbulb-outline + name: Switch to dark mode + # Palette toggle for dark mode + - media: "(prefers-color-scheme: dark)" + scheme: slate + toggle: + icon: material/lightbulb + name: Switch to light mode + logo: assets/icon-transparent.png + favicon: assets/favicon.png + features: + - navigation.instant + - navigation.indexes + - navigation.tabs + - navigation.tracking + - navigation.expand + - navigation.top + - toc.follow + - toc.integrate + - search.suggest + - search.highlight + - content.code.copy + - content.code.annotate + - content.code.select + +extra: + # sets scope of cookies to use a common path (root) +# scope: "/" + analytics: + provider: google + property: G-WMFVR98J0Q + feedback: + title: Was this page helpful? + ratings: + - icon: material/emoticon-happy-outline + name: This page was helpful + data: 1 + note: >- + Thanks for your feedback! + - icon: material/emoticon-sad-outline + name: This page could be improved + data: 0 + note: >- + Thanks for your feedback! Help us improve this page by + using our GitHub Discussions. + social: + - icon: fontawesome/brands/x-twitter + link: https://x.com/utPLSQL + name: utPLSQL on X + - icon: fontawesome/brands/linkedin + link: https://www.linkedin.com/company/utplsql/ + name: utPLSQL on LinkedIn + - icon: fontawesome/brands/bluesky + link: https://bsky.app/profile/utplsql.org + name: utPLSQL on Bluesky + - icon: fontawesome/regular/comment + link: https://github.com/utPLSQL/utPLSQL/discussions + - icon: fontawesome/brands/github + link: https://github.com/utPLSQL + - icon: fontawesome/solid/envelope + link: mailto:info@utPLSQL.org + - icon: fontawesome/solid/rss + link: https://www.utplsql.org/feed_rss_created.xml + name: Announcements RSS feed + consent: + title: Cookie consent + description: >- + We use cookies to recognize your repeated visits and preferences, as well + as to measure the effectiveness of our documentation and whether users + find what they're searching for. With your consent, you're helping us to + make our documentation better. + # the cookie: utplsql-consent allows for shred cookie across all documentation versions and the global site + cookie: utplsql-consent + version: # disable for offline docs + provider: mike # disable for offline docs +markdown_extensions: + - admonition + - pymdownx.highlight: + anchor_linenums: true + line_spans: __span + pygments_lang_class: true + - pymdownx.inlinehilite + - pymdownx.snippets + - pymdownx.superfences + - pymdownx.caret + - pymdownx.mark + - pymdownx.tilde + - attr_list + - md_in_html + - pymdownx.emoji: + emoji_index: !!python/name:material.extensions.emoji.twemoji + emoji_generator: !!python/name:material.extensions.emoji.to_svg + - toc: + permalink: true +use_directory_urls: false +hooks: + - hooks/latest_posts.py +#strict: true + +plugins: + - search + - git-committers: + repository: utPLSQL/utPLSQL.github.io + branch: main + token: !ENV ["API_TOKEN_GITHUB"] + - git-revision-date-localized: # disable for offline docs + enable_creation_date: true # disable for offline docs + type: datetime # disable for offline docs + - include-markdown + - blog: + blog_dir: announcements + post_date_format: long # e.g. "June 10, 2026" + post_url_format: "{slug}" # keeps URLs clean + archive: false + categories: true + - rss: + match_path: "announcements/posts/.*" + feed_title: "utPLSQL Announcements" + feed_description: "Releases and news from the utPLSQL project" + image: https://www.utplsql.org/assets/icon-transparent.png + date_from_meta: + as_creation: date.created + as_update: date.updated + categories: + - categories +nav: + - Home: index.md + - Announcements: + - announcements/index.md + - Documentation: + - documentation.md + - utPLSQL framework: utPLSQL/latest + - utPLSQL-cli: utPLSQL-cli.md + - utPLSQL-maven plugin: utPLSQL-maven-plugin.md + - SQLDeveloper extension: utPLSQL-SQLDeveloper.md + - PL/SQL Developer plugin: utPLSQL-PLSQL-Developer.md + - Downloads: downloads.md + - Resources: resources.md + - Sponsorship: + - Our sponsors: sponsors.md + - Become a sponsor: sponsorship.md + - About: about.md + - Contributing: contributing.md diff --git a/site-template/README.md b/site-template/README.md new file mode 100644 index 00000000..250a9f24 --- /dev/null +++ b/site-template/README.md @@ -0,0 +1,43 @@ +# utPLSQL Sub-site Template + +Copy the files from this directory into your repository to get the shared +utPLSQL.org top navigation bar automatically. + +## Setup + +**1. Copy the overrides directory into your repo's `docs/` folder:** + +``` +docs/ + overrides/ + main.html ← copied from site-template/overrides/main.html +``` + +**2. Tell MkDocs to use the overrides directory — add `custom_dir` to your `mkdocs.yml`:** + +```yaml +theme: + name: material + custom_dir: docs/overrides + # ... rest of your theme config +``` + +That's it. The topbar is loaded from `https://utplsql.org/assets/topbar.js` at +runtime, so any navigation changes made in the central org repo are picked up +automatically by all sub-sites without any further changes on your end. + +## How it works + +- `docs/overrides/main.html` extends Material's base template and injects + `topbar.js` into the `` of every page. +- `topbar.js` is published by the [utPLSQL.github.io](https://github.com/utPLSQL/utPLSQL.github.io) + repo and contains the full nav link list for utplsql.org. +- The script inserts a sticky bar above the MkDocs Material header and adjusts + the header/sidebar positions automatically. + +## Updating the shared nav + +To add or change links in the topbar, edit +[`docs/assets/topbar.js`](https://github.com/utPLSQL/utPLSQL.github.io/blob/main/docs/assets/topbar.js) +in the **utPLSQL.github.io** repo only. All sub-sites pick up the change on +next page load — no per-repo changes needed. diff --git a/site-template/overrides/main.html b/site-template/overrides/main.html new file mode 100644 index 00000000..fdfe1a3b --- /dev/null +++ b/site-template/overrides/main.html @@ -0,0 +1,12 @@ +{% extends "base.html" %} +{# + Sub-repository template override. + Loads the shared utPLSQL.org top navigation bar from the central org site. + The topbar.js file is the single source of truth — update nav links there only. +#} + +{% block extrahead %} + {{ super() }} + + +{% endblock %}