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.

Sign up for GitHub

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

Jump to bottom

README.md changes for the publish instructions #46

Merged
merged 3 commits into from
Aug 22, 2023
Merged

README.md changes for the publish instructions #46

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d2d5444
README.md changes for the publish instructions
chrisli30 Aug 22, 2023
3e8df95
Correct npm-publish-dev workflow
chrisli30 Aug 22, 2023
841d9d3
Correct npm-publish-dev workflow
chrisli30 Aug 22, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 5 additions & 6 deletions .github/workflows/npm-publish-dev.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
name: Publish dev version

on:
workflow_run:
workflows: ["Publish dev version"]
types:
- manual
workflow_dispatch:
inputs:
trigger-manual:
description: 'Manually trigger the workflow'

jobs:
publish-dev-version:
Expand All @@ -29,7 +29,7 @@ jobs:
run: echo "//registry.npmjs.org/:_authToken=${{ secrets.NPM_AUTOMATION_TOKEN_CHRIS }}" > ~/.npmrc

- name: Publish packages to NPM with dev tag
run: |
run: |
for dir in packages/*; do
if [ -d "$dir" ]; then
echo "Publishing $dir package"
Expand All @@ -38,4 +38,3 @@ jobs:
cd ..
fi
done

4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,8 +99,8 @@ The build command will generate distribution files under `packages/api-augment/b

## Publishing the Packages
The release creation and publish is completely handled by Github Actions.
1. In order to trigger a version update, you need to run `npm run changeset` locally to generate a new version number and a Release Changelog. The script will create a .md file under .changeset like this PR, https://github.com/OAK-Foundation/oak.js/commit/c35050eb16bb73251fb05dd9010ab577f2adf5d6.
2. Once the above PR is merged to main, an Action will be triggered to update all package versions automatically, as seen in this PR, https://github.com/OAK-Foundation/oak.js/pull/42.
1. In order to trigger a version update, you need to run `npm run changeset` locally to generate a mark file. The script will create a .md file under .changeset like this PR, https://github.com/OAK-Foundation/oak.js/commit/c35050eb16bb73251fb05dd9010ab577f2adf5d6.
2. Once the above PR is merged to main, an Action will be triggered by that mark file to create a PR to update all package versions automatically, as seen in this PR, https://github.com/OAK-Foundation/oak.js/pull/42. If you need to stack more changes on to the same version, just re-run step 1 to create another mark file and merge it to the main branch.
3. If things look good, merge the above PR created by changeset, and run the **Publish dev version** workflow manually to publish an NPM package version with `dev` tag for testing.
4. If testing goes well, run the **Make dev version latest** workflow manually to update the npm tag of `dev` to `latest`.

Expand Down