diff --git a/README.md b/README.md index 0c4b213..bb09b9b 100644 --- a/README.md +++ b/README.md @@ -91,7 +91,7 @@ The project provides a set of [entrypoint scripts](src/scripts/ci) for generatin #### Generating release notes -The entrypoint script [`Invoke-Generate.ps1`](src/scripts/ci/Invoke-Generate.ps1) is used to generate release notes for any local git repository. To do so, simply define applicable [environment variables](#environment-variables) before executing the entrypoint script. +The entrypoint script [`Invoke-Generate.ps1`](src/scripts/ci/Invoke-Generate.ps1) is used to generate release notes for any local git repository. To do so, simply define applicable [environment variables](#environment-variables-1) before executing the entrypoint script. The project includes [`.vscode/tasks.json`](.vscode/tasks.json) which allows execution of `Invoke-Generate.ps1` via [*Build Tasks*](https://code.visualstudio.com/docs/editor/tasks) in [VSCode](https://code.visualstudio.com/). Simply execute the relevant build task while entering custom or default values per variable prompt. @@ -115,7 +115,7 @@ git tag v1.0.12-beta.1 #### Creating releases -The entrypoint script [`Invoke-Release.ps1`](src/scripts/ci/Invoke-Release.ps1) can be used to create releases for GitHub repositories. To do so, simply define applicable [environment variables](#environment-variables) before executing the entrypoint script. +The entrypoint script [`Invoke-Release.ps1`](src/scripts/ci/Invoke-Release.ps1) can be used to create releases for GitHub repositories. To do so, simply define applicable [environment variables](#environment-variables-1) before executing the entrypoint script. The project includes [`.vscode/tasks.json`](.vscode/tasks.json) which allows execution of `Invoke-Release.ps1` via [*Build Tasks*](https://code.visualstudio.com/docs/editor/tasks) in [VSCode](https://code.visualstudio.com/). Simply execute the relevant build task while entering custom or default values per variable prompt. Note that due to the inability to enter multiline strings in build tasks, the options `RELEASE_NOTES_CONTENT` and `RELEASE_ASSETS` are presently unavailable and limited in usability respectively. @@ -160,14 +160,13 @@ The following are environment variables supported by the provided [entrypoint sc ##### Commands -To generate release notes and create releases, simply clone a specified *version* of the project, and define applicable [environment variables](#environment-variables) before executing the project's provided entrypoint script(s) within the CI environment. +To generate release notes and create releases, simply clone a specified *version* of the project, and define applicable [environment variables](#environment-variables-1) before executing the project's provided entrypoint script(s) within the CI environment. ```shell # Clone PSRepositoryReleaseManager git clone https://github.com/theohbrothers/PSRepositoryReleaseManager.git --recurse-submodules --branch 'vx.x.x' # Specify tag ref to checkout to # Process applicable environment variables -export PROJECT_DIRECTORY=$( git rev-parse --show-toplevel ) export RELEASE_TAG_REF=$( echo "$GITHUB_REF" | sed -rn 's/^refs\/tags\/(.*)/\1/p' ) export RELEASE_NAMESPACE="$GITHUB_REPOSITORY_OWNER" export RELEASE_REPOSITORY=$( basename "$( git rev-parse --show-toplevel )" ) diff --git a/docs/samples/ci/github/generic/github-workflows.linux-container.yml b/docs/samples/ci/github/generic/github-workflows.linux-container.yml index 8b08c04..b1d884f 100644 --- a/docs/samples/ci/github/generic/github-workflows.linux-container.yml +++ b/docs/samples/ci/github/generic/github-workflows.linux-container.yml @@ -42,7 +42,6 @@ jobs: git clone https://github.com/theohbrothers/PSRepositoryReleaseManager.git --recurse-submodules --depth 1 --shallow-submodules --branch 'vx.x.x' # Specify tag ref to checkout to # Process applicable environment variables - export PROJECT_DIRECTORY=$( git rev-parse --show-toplevel ) export RELEASE_TAG_REF=$( echo "$GITHUB_REF" | sed -rn 's/^refs\/tags\/(.*)/\1/p' ) # Generate (Generates release notes) @@ -59,7 +58,6 @@ jobs: GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | # Process applicable environment variables - export PROJECT_DIRECTORY=$( git rev-parse --show-toplevel ) export RELEASE_TAG_REF=$( echo "$GITHUB_REF" | sed -rn 's/^refs\/tags\/(.*)/\1/p' ) export RELEASE_NAMESPACE="$GITHUB_REPOSITORY_OWNER" export RELEASE_REPOSITORY=$( basename "$( git rev-parse --show-toplevel )" ) diff --git a/docs/samples/ci/github/generic/github-workflows.linux.yml b/docs/samples/ci/github/generic/github-workflows.linux.yml index b5de4ed..5158c01 100644 --- a/docs/samples/ci/github/generic/github-workflows.linux.yml +++ b/docs/samples/ci/github/generic/github-workflows.linux.yml @@ -37,7 +37,6 @@ jobs: git clone https://github.com/theohbrothers/PSRepositoryReleaseManager.git --recurse-submodules --depth 1 --shallow-submodules --branch 'vx.x.x' # Specify tag ref to checkout to # Process applicable environment variables - export PROJECT_DIRECTORY=$( git rev-parse --show-toplevel ) export RELEASE_TAG_REF=$( echo "$GITHUB_REF" | sed -rn 's/^refs\/tags\/(.*)/\1/p' ) # Generate (Generates release notes) @@ -54,7 +53,6 @@ jobs: GITHUB_API_TOKEN: ${{ secrets.GITHUB_TOKEN }} run: | # Process applicable environment variables - export PROJECT_DIRECTORY=$( git rev-parse --show-toplevel ) export RELEASE_TAG_REF=$( echo "$GITHUB_REF" | sed -rn 's/^refs\/tags\/(.*)/\1/p' ) export RELEASE_NAMESPACE="$GITHUB_REPOSITORY_OWNER" export RELEASE_REPOSITORY=$( basename "$( git rev-parse --show-toplevel )" )