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

set up readme to update automatically upon publish of new plugins/ext… #133

Merged
merged 8 commits into from
Aug 20, 2024

Conversation

cherriechang
Copy link
Contributor

…ensions

Copy link

changeset-bot bot commented Aug 9, 2024

⚠️ No Changeset found

Latest commit: 9620b56

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR


- name: Update README list of plugins and extensions
run: npm run update-readme.js

Copy link
Member

Choose a reason for hiding this comment

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

Don't forget to add the commit and push actions here.

Copy link
Member

Choose a reason for hiding this comment

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

Quickly dropping a note here that we can just make the changesets action do the commit work for us:

    "update-unpkg-links": "gulp updateUnpkgLinks",
+   "update-readme": "node update-readme.js",
    "prepare": "husky install",
    "changeset": "changeset",
-   "changeset:version": "changeset version && npm install && npm run update-unpkg-links",
+   "changeset:version": "changeset version && npm install && npm run update-unpkg-links && npm run update-readme",

@@ -28,6 +28,7 @@
"directory": "packages/extension-countdown"
},
"author": "Shaobin Jiang",
"authorGitHub": "https://github.com/Shaobin-Jiang",
Copy link
Member

Choose a reason for hiding this comment

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

I think we should make this compliant with how npm expects it:

https://docs.npmjs.com/cli/v10/configuring-npm/package-json#people-fields-author-contributors

templates/cli/src/index.js Outdated Show resolved Hide resolved
package.json Outdated Show resolved Hide resolved
@cherriechang cherriechang merged commit 1758263 into main Aug 20, 2024
4 checks passed
@cherriechang cherriechang deleted the automate-readme-update branch August 20, 2024 18:13
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