This repository was archived by the owner on Dec 11, 2024. It is now read-only.
Tags: agilepathway/gauge-jira
Tags
Fix Codespace devcontainer project root variable (#27) * Fix Codespace devcontainer project root variable This is an internal development environment only change - no change to the plugin's production code. The directory that GitHub Codespaces opens in changed recently, (e.g. to `workspaces/gauge-jira` for this project) in a recent update to Codespaces. This meant that the unit tests were failing when run from within the Codespace, because the required `GAUGE_PROJECT_ROOT` environment variable was now pointing to the wrong directory. Happily the fix in this commit means that we now define the `GAUGE_PROJECT_ROOT` variable dynamically when setting up the Codespace devcontainer, based on the [`containerWorkspaceFolder` value][1]. The [VSCode devcontainer documentation at the time of this commit still says that `containerWorkspaceFolder` is not supported within Codespaces][1], so the guess is that either this capability was recently added to Codespaces and the documentation has not been updated yet, or that it has always been possible to _read_ the `containerWorkspaceFolder` value, just not to write it. [1]: https://code.visualstudio.com/docs/remote/devcontainerjson-reference#_variables-in-devcontainerjson * Bump plugin patch version
Derive branch for Git spec url from Git (#26) * Derive remote branch to use in spec Git URL This commit ensures that the links from published specs in Jira back to the specs in Git link to the current branch that the user of the plugin is on when running the plugin. Prior to this commit the branch was hardcoded to master. It gives more control to the users of the plugin to allow them to choose whichever branch they like to appear to in the Git links, simply by changing the branch which they use to run the plugin from. * Clean up expectedBasicScenarioHeader test methods * Inline test method * Clean up command test methods * Add console output for unhappy paths * Refactor git package into atomic files * Bump plugin minor version
Derive spec Git URL instead of using config var (#24) * Derive spec Git URL instead of using config var This is a big change that also means we allow multiple specs directories (or files) to be passed in to the `gauge docs jira` command again (we had removed this capability in the previous [0.2.0 release][1]). [1]: https://github.com/agilepathway/gauge-jira/releases/tag/v0.2.0 * Bump plugin minor version
Fix Git URL formatting bug on Windows (#25) * Run functional tests on Windows * Fix Git URL formatting bug on Windows The bug was caused by not converting Windows paths (which have forward slashes) into URL paths (with back slashes). * Bump plugin version
Add link to each spec's Git URL (#22) * Add link to each spec's Git URL This is a breaking change, as it requires a new mandatory `SPECS_GIT_URL`configuration variable to be provided by users of the plugin. * Extract regex method * Fail fast if multiple spec directories passed in Gauge documentation plugins allow multiple specs directories to be passed in when invoking the plugin (from the command line). We now fail fast if more than one directory is passed in, as this Jira plugin needs there to be just one specs directory (so it can be mapped to the specs Git url). * Refactor internal usage of SPECS_GIT_URL env var * Bump plugin version to 0.2.0 Bumped the minor version rather than patch as this is a breaking change. (If we were already at version 1.0.0 or above then it would have been a major version change.)
Fix duplicate Gauge examples section bug (#20) * Bump plugin version to 0.1.7 * Fix duplicate Gauge examples section bug Sometimes when a Jira issue is edited manually it will lead to headings (e.g. in the description field) either having a space or not having a space between the heading and the heading text. The bug was caused by us always expecting the Gauge specs section in the Jira to have an h2 heading with no space between the h2 and the heading text. This commit fixes that bug by handling both scenarios - we now allow for there to be no space, or any number of spaces. * Make logic to replace Gauge section less brittle This commit caters for a situation where the whitespace in the Gauge specifications section of the Jira issue description changes (e.g. if a manual edit to the issue description inadvertently changes it). Prior to this commit that would cause the Gauge specs section to be duplicated (rather than being replaced as it should), on the next running of the Gauge Jira plugin. * Fix bug where footer was sometimes indented Sometimes the footer of the Gauge specs section in Jira was being erroneously indented, e.g. if the specs finished with a table. This commit fixes the bug by adding a newline at the beginning of the footer. * Extract method to new regex utility package
Prevent publishing when issue is in invalid state (#19) Jira issues should only ever contain one Gauge examples section, currently (NB we may change this in the future if we cater for more than one source repo separately publishing their Gauge specs to the same Jira issue). This commit prevents publishing of specs to a Jira issue which is in an invalid state because it has more than one Gauge examples section in the Jira issue description. A Jira issue could get into this invalid state either because of a manual edit, or because of a bug (hypothetically) in the Gauge Jira plugin itself which inadvertently led to a duplicate examples section instead of replacing the existing one.
PreviousNext