-
Notifications
You must be signed in to change notification settings - Fork 139
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
docs: Add examples for GitHub Actions #540
Conversation
✅ Deploy Preview for creative-fairy-df92c4 ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good. Here's the workflow I was gonna add, for reference: https://github.com/aklinker1/github-better-line-counts/blob/main/.github/workflows/submit.yml
I guess I just forgot to add it? I wrote that a while ago.
It generates a changelog and github release based on conventional commits. I wonder what the best way to document different versioning strategies is?
docs/guide/publishing.md
Outdated
```yml [npm] | ||
env: | ||
DIRECTORY: .output | ||
PROJECT_NAME: myextension | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you think we need multiple examples for package managers? Or should we just list one?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I did it, but I think it would be better to keep only pnpm.
docs/guide/publishing.md
Outdated
- name: Build extensions | ||
run: | | ||
npm run build && | ||
npm run build:firefox |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- name: Build extensions | |
run: | | |
npm run build && | |
npm run build:firefox |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sorry, I made a mistake above when I thought I was commenting on your answer.... I don't know if there's a way to undo that (I'm a bit new to the world of contribution).
Could there be a section called "on dispatch" and another called "on push"? I also have a realease creation step that I had removed, but I can integrate it. - name: Create Release
uses: softprops/action-gh-release@v2
env:
GITHUB_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
with:
tag_name: "v${{ needs.Version.outputs.version }}"
name: "v${{ needs.Version.outputs.version }}"
draft: false
prerelease: false
files: |
${{ env.DIRECTORY }}/${{env.PROJECT_NAME}}-${{ needs.Version.outputs.version }}-chrome.zip
${{ env.DIRECTORY }}/${{env.PROJECT_NAME}}-${{ needs.Version.outputs.version }}-firefox.zip
${{ env.DIRECTORY }}/${{env.PROJECT_NAME}}-${{ needs.Version.outputs.version }}-sources.zip Your CI is very elaborate and I don't know if mine is really necessary.. |
Maybe we just list the two steps that are important (zip and submit), then link to each of our projects for full workflow examples? |
02e1a24
to
2ff418e
Compare
I think it's a good idea, it could look like what I've pushed. Maybe a "tip" section isn't the right choice? Also, I may have been a bit too verbose. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@GuiEpi I updated the wording a little bit, pulled the examples out of the info block, and listed the actual features of the two example workflows so it's more clear what the difference is.
Thanks for adding this for me!
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #540 +/- ##
==========================================
+ Coverage 86.31% 86.40% +0.09%
==========================================
Files 111 111
Lines 8864 8864
Branches 873 876 +3
==========================================
+ Hits 7651 7659 +8
+ Misses 1199 1191 -8
Partials 14 14 ☔ View full report in Codecov by Sentry. |
Here is my proposal for the github action in the publishing section of the documentation.
Jobs
Version
Checks for changes in the
package.json
file. If there is a change, it retrieves the version of your extension.Submit
Submits your extension to the store using the
wxt submit
command.pnpm
andnpm
code-group.Here's a link to my CI Deploy to show you how it works.
I follow the pnpm continuous integration guide and your publishing section.