docs: clarify code comments

This commit is contained in:
Dustin Ruetz
2024-04-04 21:14:15 -04:00
parent baa29d5bd0
commit cca0f55ece
2 changed files with 3 additions and 2 deletions

View File

@@ -3,8 +3,9 @@ name: Release
on: on:
push: push:
branches: branches:
# TODO: This branch is for PR testing purposes, update to "main" if we proceed with this PR. # TODO: This branch is for PR testing purposes; update branch to "main" if we proceed with this PR.
- ruetz-automate-releases - ruetz-automate-releases
# Specify that this "Release" workflow depends on the other workflows below completing successfully.
workflow_run: workflow_run:
workflows: ["Lint", "Run acceptance tests"] workflows: ["Lint", "Run acceptance tests"]
types: types:

View File

@@ -2,7 +2,7 @@
* @type {import('semantic-release').GlobalConfig} * @type {import('semantic-release').GlobalConfig}
*/ */
module.exports = { module.exports = {
// TODO: This branch is for PR testing purposes, update to "main" if we proceed with this PR. // TODO: This branch is for PR testing purposes; update branch to "main" if we proceed with this PR.
branches: ["ruetz-automate-releases"], branches: ["ruetz-automate-releases"],
// TODO: Remove `dryRun` configuration if we proceed with this PR. // TODO: Remove `dryRun` configuration if we proceed with this PR.
dryRun: true, dryRun: true,