Skip to content

Commit

Permalink
chore: updates release notes (#504)
Browse files Browse the repository at this point in the history
removes the broken release github workflow
updates changelog
  • Loading branch information
krpeacock authored Sep 30, 2021
1 parent 37c973d commit 6b99a37
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 40 deletions.
39 changes: 0 additions & 39 deletions .github/workflows/release.yml

This file was deleted.

11 changes: 10 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,21 @@ To publish to NPM, create a branch and run the following commands;
- `npm install`. Makes sure everything is installed and up to date locally;
- `npm run build --workspaces`. Builds all the applications and packages.
- `npm run version [patch|major|minor|version]`. Update the version in each of the packages.
- Manually update the version in the root package.json file.
- `npm install`. Updates the versions of the packages in the package-lock.json file.
- `git checkout -b release/v<#.#.#>`. Check out release branch
- `git add .`. Check out release branch
- `git commit -m 'chore: release v<#.#.#>'`. Commit changes
- Open a pull request from your fork of the repository

Then, when you have merged the new versions, open https://github.com/dfinity/agent-js/releases/new, click the "Draft a new release" button, enter the new tag version in form `v#.#.#`, and click "Publish release".
Once the change is merged, you can publish to NPM. To publish to NPM, run the following commands;

- `npm run build --workspaces`. This is just for safety
- `npm publish --workspaces`. Publishes the packages to NPM.
- You will need to have authorization to publish the npm packages in our NPM organization. Reach out to IT if you neeed access.
- You can add the `--dry-run` flag to see what would have been published and make sure that all the versions and packages look correct.

Then, when you have merged the new versions and published to npm, open https://github.com/dfinity/agent-js/releases/new, click the "Draft a new release" button, enter the new tag version in form `v#.#.#`, and click "Publish release".

### Publishing Docs

Expand Down
14 changes: 14 additions & 0 deletions docs/generated/changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,20 @@
<h1>Agent-JS Changelog</h1>

<section>
<h2>Version 0.10.1</h2>
<ul>
<li>
Fix for the auth-client identity option and added JSDOC comment for the timeToLive option
</li>
<li>
Sets the default Internet Identity expiration to 1 day for the authClient, up from 15
minutes
</li>
<li>
No longer checks instanceof Principal in @dfinity/agent, which should allow non-identical
versions of packages to interoperate, as long as they share the same API
</li>
</ul>
<h2>Version 0.10.0</h2>
<ul>
<li>Adds changelog for agent-js packages</li>
Expand Down

0 comments on commit 6b99a37

Please sign in to comment.