Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: scaffold release workflows #2278

Draft
wants to merge 15 commits into
base: master
Choose a base branch
from
Draft

Conversation

maverick1872
Copy link
Member

@maverick1872 maverick1872 commented Feb 6, 2023

Purpose

To support releasing & publishing new versions (of all kinds) from within the repository in a consistent manner.

Proposed process to take advantage of these workflows

To be filled out

Requirements to function

Secrets

  • RELEASE_OPS_PRIVATE_KEY - Private key of a key/pair generated for the GitHub app that is used to generate a token.
  • PUBLISH_TOKEN - NPM access token with publish permissions

Non Secret Variables (allow for easier migration between repos)

  • RELEASE_OPS_APP_ID - This I believe this is a static value. Currently it's 291962 (GitHub app developed by me, requested to install to this repo). This is subject to the app that is leveraged though.
  • NPM_SCOPE - This is the scope in which the package should be published under on NPM. Currently the package is not published under a scope but I'd advocate we start publishing under the organization name @winstonjs

Additional aspects that can likely be made configurable via the non-secret repo variables.

  • Git tag prefix
  • Release branch prefix
  • Release candidate prefix/structure
  • ... I'm sure there's others but none that come to mind right now.

To-do Items

  • Update publishing.md documentation

Copy link
Contributor

@wbt wbt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test/unit/formats/errors.test.js Outdated Show resolved Hide resolved
@maverick1872
Copy link
Member Author

maverick1872 commented Feb 17, 2023

@wbt @DABH Spent some time over the past week or so really refining the interactions and process between these workflows. From a practical example perspective you can look at this PR & Repo of mine that I've been using as a test-bed. If y'all want to play around with it I can make that happen.

@DABH I sent you an email regarding the "Secret" requirements for these workflows. Just to re-iterate them here for context they are the following:

Secrets:

  • RELEASE_OPS_PRIVATE_KEY - Private key of a key/pair generated for the GitHub app that is used to generate a token.
  • PUBLISH_TOKEN - NPM access token with publish permissions

Non Secret Variables (allow for easier migration between repos):

  • RELEASE_OPS_APP_ID - This I believe this is a static value. Currently it's 291962 (GitHub app developed by me, requested to install to this repo). This is subject to the app that is leveraged though.
  • NPM_SCOPE - This is the scope in which the package should be published under on NPM. Currently the package is not published under a scope but I'd advocate we start publishing under the organization name @winstonjs

Will be updating the overall PR description to describe the process that this supports in the next day or so. Probably won't get to it tonight as it's late for me.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants