Skip to content

Add workflow to automate component status board updates #1672

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

Merged
merged 32 commits into from
Dec 2, 2021

Conversation

rezrah
Copy link
Contributor

@rezrah rezrah commented Dec 1, 2021

Summary

Adds a new Actions-based workflow to automatically organise Component cards, along with their corresponding lifecycle status on a new Component Status project board.

Demo

See it in action here: https://github.com/primer/react/projects/5

This automation functionality was requested by LT, and deploys alongside our docs component status page. They both share the same data source so maintaining this board will require no additional overhead.

Big thanks to PVC team for creating the card upsert script. I've adapted it to work for our PRC project in this PR.

Contributes to https://github.com/github/primer/issues/339

Screenshots

PRC board:
Screenshot 2021-12-01 at 00 47 27

PVC board for reference:
Screenshot 2021-12-01 at 00 53 41

Merge checklist

  • Added/updated tests
  • Added/updated documentation
  • Tested in Chrome
  • Tested in Firefox
  • Tested in Safari
  • Tested in Edge

Sorry, something went wrong.

@rezrah rezrah requested review from a team and colebemis December 1, 2021 00:59
@changeset-bot
Copy link

changeset-bot bot commented Dec 1, 2021

⚠️ No Changeset found

Latest commit: 8af4dee

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

@rezrah rezrah added the skip changeset This change does not need a changelog label Dec 1, 2021
@github-actions
Copy link
Contributor

github-actions bot commented Dec 1, 2021

size-limit report 📦

Path Size
dist/browser.esm.js 57.34 KB (0%)
dist/browser.umd.js 57.74 KB (0%)

Copy link
Contributor

@colebemis colebemis left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks for the quick turnaround on this ✨

Just left a couple non-blocking comments. After you fix the lint error, this should be good to go 🚢

@colebemis
Copy link
Contributor

Hmm, do you know why the package-lock got a lot smaller?

…rimer/react into feature/component-status-project-board
@rezrah
Copy link
Contributor Author

rezrah commented Dec 1, 2021

Hmm, do you know why the package-lock got a lot smaller?

Found the issue. package-lock was generated using v1, when it should be v2. Should be sorted now.

Just left a couple non-blocking comments. After you fix the lint error, this should be good to go 🚢

Thanks @colebemis. Lint issues fixed now. Going to merge later today, in case there's any other feedback coming.

tsconfig.json Outdated
@@ -16,5 +16,5 @@
"forceConsistentCasingInFileNames": true,
"typeRoots": ["./node_modules/@types", "./@types"]
},
"include": ["@types/**/*.ts", "src/**/*.js", "src/**/*.ts", "src/**/*.tsx"]
"include": ["@types/**/*.ts", "script/**/*.ts", "src/**/*.js", "src/**/*.ts", "src/**/*.tsx"]
Copy link
Contributor

Choose a reason for hiding this comment

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

Can you confirm that we're not accidentally publishing script/** type declaration files to the npm package?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

component-status.json won't appear in the package, as it's ephemeral to its own isolated workflow. This can be verified in the canary release here.

@colebemis, the d.ts files are back now too. Had to add the scripts folder to tsconfig.build.json

@rezrah rezrah merged commit cfbafe6 into main Dec 2, 2021
@rezrah rezrah deleted the feature/component-status-project-board branch December 2, 2021 10:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip changeset This change does not need a changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants