Automate publishing crates to crates.io #1364

musicinmybrain · 2024-07-11T15:30:50Z

This mostly reverts 5085c5b, and attempts to support publishing workspace crates onefetch-ascii, onefetch-image, and onefetch-manifest. This would fix #1363 by ensuring crates are published on a platform that fully supports symbolic links.

I have little to no experience with GitHub Workflows, and I am unable to test this PR, but it still seems like it should do the job.

spenserblack

This looks mostly good. Could you use cargo publish -p PACKAGE-NAME instead of setting the working directory? I know I suggested changing the working directories in 5085c5b, but I think using cargo publish -p PACKAGE-NAME is slightly cleaner. As an added bonus one could just copy+paste the steps and run them from the project's root to publish manually if we avoid modifying the working directory.

.github/workflows/cd.yml

spenserblack · 2024-07-11T16:44:10Z

I am unable to test this PR

Honestly when it comes to situations like this I think it's fine to basically test in production. In other words, just trigger the workflow when we're ready and expect it to work. If there's anything to fix we can make a new patch release to re-trigger the workflow. I've even seen big projects like Vue make new patches just to re-trigger a previously broken CD.

Though of course we would never merge in a broken CD workflow 😉

spenserblack

Sorry, went through this again and had a few more comments.

spenserblack · 2024-07-11T16:45:35Z

.github/workflows/cd.yml

+      CARGO_TERM_COLOR: always
+
+    steps:
+      - uses: actions/checkout@v3


Suggested change

- uses: actions/checkout@v3

- uses: actions/checkout@v4

spenserblack · 2024-07-11T16:47:05Z

.github/workflows/cd.yml

+    env:
+      CARGO_TERM_COLOR: always


I think that this environment variable can actually be set on the workflow level (root level), not the job level. That way it will be set for all jobs, which should help on build steps for other jobs.

I’ll give it a try! This is how it was done in the “old” implementation, but that doesn’t make it optimal. Documentation supports your claim: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#env

spenserblack · 2024-07-11T16:50:17Z

.github/workflows/cd.yml

+      - name: Install Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: stable
+          profile: minimal
+          components: clippy
+


All of actions-rs is deprecated right now. TBH I'm wondering if we actually need a step to install Rust here. GitHub Actions have Rust and cargo installed by default, and typically a pretty recent version AFAIK. I never bothered to explicitly install the Rust toolchain in some personal projects, and I've never had a problem.

Interesting. Looking more closely, the existing deploy job has the following “Install Rust” step:

onefetch/.github/workflows/cd.yml

Lines 17 to 21 in ac7e2b8

- name: Install Rust

uses: dtolnay/rust-toolchain@v1

with:

toolchain: stable

components: clippy

I suppose it makes sense to either match that in cargo-publish, or remove both “Install Rust” steps. What do you think?

Let's add dtolnay's action for consistency.

This mostly reverts commit 5085c5b. The goal is to restore `cargo-publish` automation, and fix handling of workspace crates in a follow-up commit.

Fixes o2sh#1363 by ensuring crates are published on a platform that fully supports symbolic links. Based on a suggestion in o2sh@5085c5b#commitcomment-91354413.

musicinmybrain · 2024-07-11T17:48:42Z

This looks mostly good. Could you use cargo publish -p PACKAGE-NAME instead of setting the working directory? I know I suggested changing the working directories in 5085c5b, but I think using cargo publish -p PACKAGE-NAME is slightly cleaner. As an added bonus one could just copy+paste the steps and run them from the project's root to publish manually if we avoid modifying the working directory.

I’ll follow up with this change next. $ cargo publish -p onefetch-ascii --dry-run works, so it should be fine.

musicinmybrain · 2024-07-11T17:50:55Z

I think I handled all the feedback except for #1364 (comment). Let me know what you think about #1364 (comment), and I’ll be back to this in a few hours.

spenserblack · 2024-07-11T17:54:38Z

I think I handled all the feedback except for #1364 (comment). Let me know what you think about #1364 (comment), and I’ll be back to this in a few hours.

Great! Once you resolve #1364 (comment) this will be good to me.

musicinmybrain · 2024-07-12T14:36:34Z

I think I handled all the feedback except for #1364 (comment). Let me know what you think about #1364 (comment), and I’ll be back to this in a few hours.

Great! Once you resolve #1364 (comment) this will be good to me.

Done! Thank you for the thorough and helpful review.

spenserblack

Looks good! Congrats on getting some experience with GH Workflows!

This MR contains the following updates: | Package | Update | Change | |---|---|---| | [o2sh/onefetch](https://github.com/o2sh/onefetch) | minor | `2.21.0` -> `2.22.0` | MR created with the help of [el-capitano/tools/renovate-bot](https://gitlab.com/el-capitano/tools/renovate-bot). **Proposed changes to behavior should be submitted there as MRs.** --- ### Release Notes <details> <summary>o2sh/onefetch (o2sh/onefetch)</summary> ### [`v2.22.0`](https://github.com/o2sh/onefetch/blob/HEAD/CHANGELOG.md#2220-2024-09-20) [Compare Source](o2sh/onefetch@2.21.0...2.22.0) ##### New Features 🎉 - Add support for nerd font glyphs in languages info by [@Localghost385](https://github.com/Localghost385) in o2sh/onefetch#1395 - \[onefetch.dev] Add nerdfont iconts to the preview by [@Localghost385](https://github.com/Localghost385) in o2sh/onefetch#1411 - Automate publishing crates to crates.io by [@musicinmybrain](https://github.com/musicinmybrain) in o2sh/onefetch#1364 ##### Bug Fixes 🐛 - Show future commit dates without panicking by [@MalteT](https://github.com/MalteT) in o2sh/onefetch#1389 ##### Chores 🧹 - Re-generate the man page with --no-info by [@musicinmybrain](https://github.com/musicinmybrain) in o2sh/onefetch#1376 - Drop unused shebangs from repo test fixture scripts by [@musicinmybrain](https://github.com/musicinmybrain) in o2sh/onefetch#1375 ##### Commit Statistics <csr-read-only-do-not-edit/> - 3 commits contributed to the release. - 135 days passed between releases. - 0 commits were understood as [conventional](https://www.conventionalcommits.org). - 3 unique issues were worked on: [#1389](o2sh/onefetch#1389), [#1395](o2sh/onefetch#1395), [#1404](o2sh/onefetch#1404) ##### Commit Details <csr-read-only-do-not-edit/> <details><summary>view details</summary> - **[#1389](o2sh/onefetch#1389 - Show future commit dates without panicking ([`61ab298`](o2sh/onefetch@61ab298)) - **[#1395](o2sh/onefetch#1395 - Add support for nerd font glyphs in languages info ([`6bf1807`](o2sh/onefetch@6bf1807)) - **[#1404](o2sh/onefetch#1404 - Bump gix from 0.64.0 to 0.66.0 in the gix group ([`19f77b2`](o2sh/onefetch@19f77b2)) </details> </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

musicinmybrain requested review from spenserblack and o2sh as code owners July 11, 2024 15:30

vercel bot deployed to Preview July 11, 2024 15:31 View deployment

spenserblack requested changes Jul 11, 2024

View reviewed changes

.github/workflows/cd.yml Show resolved Hide resolved

spenserblack requested changes Jul 11, 2024

View reviewed changes

musicinmybrain added 4 commits July 11, 2024 13:32

Revert "fix cd" (but keep the added version)

a804379

This mostly reverts commit 5085c5b. The goal is to restore `cargo-publish` automation, and fix handling of workspace crates in a follow-up commit.

Fix publishing workspace crates via CD

0ba9ced

Fixes o2sh#1363 by ensuring crates are published on a platform that fully supports symbolic links. Based on a suggestion in o2sh@5085c5b#commitcomment-91354413.

Update checkout action to v4 in restored cargo-publish workflow

e5683c6

Set CARGO_TERM_COLOR=always for all CD jobs

477921c

musicinmybrain force-pushed the automate-publish branch from 8e51c0f to 477921c Compare July 11, 2024 17:41

vercel bot deployed to Preview July 11, 2024 17:41 View deployment

When publishing workspace crates, use -p instead of changing directory

c896133

vercel bot deployed to Preview July 11, 2024 17:50 View deployment

“Install Rust” action in cargo-publish now matches deploy job

4ec673e

vercel bot deployed to Preview July 12, 2024 14:36 View deployment

musicinmybrain referenced this pull request Jul 12, 2024

fix cd

5085c5b

spenserblack approved these changes Jul 12, 2024

View reviewed changes

spenserblack changed the title ~~Restore CD automation for publishing crates, and support workspace crates~~ Automate publishing crates to crates.io Jul 12, 2024

o2sh approved these changes Jul 13, 2024

View reviewed changes

o2sh merged commit 21af7c9 into o2sh:main Jul 13, 2024
11 checks passed

o2sh added the feat label Sep 15, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automate publishing crates to crates.io #1364

Automate publishing crates to crates.io #1364

musicinmybrain commented Jul 11, 2024 •

edited

Loading

spenserblack left a comment •

edited

Loading

spenserblack commented Jul 11, 2024

spenserblack left a comment

spenserblack Jul 11, 2024

musicinmybrain Jul 11, 2024

spenserblack Jul 11, 2024

musicinmybrain Jul 11, 2024

spenserblack Jul 11, 2024

musicinmybrain Jul 11, 2024

spenserblack Jul 11, 2024

musicinmybrain commented Jul 11, 2024

musicinmybrain commented Jul 11, 2024

spenserblack commented Jul 11, 2024

musicinmybrain commented Jul 12, 2024

spenserblack left a comment

	- name: Install Rust
	uses: dtolnay/rust-toolchain@v1
	with:
	toolchain: stable
	components: clippy

Automate publishing crates to crates.io #1364

Automate publishing crates to crates.io #1364

Conversation

musicinmybrain commented Jul 11, 2024 • edited Loading

spenserblack left a comment • edited Loading

Choose a reason for hiding this comment

spenserblack commented Jul 11, 2024

spenserblack left a comment

Choose a reason for hiding this comment

spenserblack Jul 11, 2024

Choose a reason for hiding this comment

musicinmybrain Jul 11, 2024

Choose a reason for hiding this comment

spenserblack Jul 11, 2024

Choose a reason for hiding this comment

musicinmybrain Jul 11, 2024

Choose a reason for hiding this comment

spenserblack Jul 11, 2024

Choose a reason for hiding this comment

musicinmybrain Jul 11, 2024

Choose a reason for hiding this comment

spenserblack Jul 11, 2024

Choose a reason for hiding this comment

musicinmybrain commented Jul 11, 2024

musicinmybrain commented Jul 11, 2024

spenserblack commented Jul 11, 2024

musicinmybrain commented Jul 12, 2024

spenserblack left a comment

Choose a reason for hiding this comment

musicinmybrain commented Jul 11, 2024 •

edited

Loading

spenserblack left a comment •

edited

Loading