cargo release helper #790

Gesloten
igalic wil 50 commits van igalic/fix/cargo-release-helper samenvoegen met master
igalic reageerde 4 jaren geleden (Gemigreerd van github.com)

how to use?

cargo release --dry-run --workspace minor
- add support for [cargo-release](https://github.com/sunng87/cargo-release) - add & backfill Changelog! ---- how to use? ```shell cargo release --dry-run --workspace minor ```
codecov[bot] reageerde 4 jaren geleden (Gemigreerd van github.com)

Codecov Report

Merging #790 into master will increase coverage by 0.02%.
The diff coverage is n/a.

@@            Coverage Diff             @@
##           master     #790      +/-   ##
==========================================
+ Coverage   39.09%   39.11%   +0.02%     
==========================================
  Files          73       73              
  Lines        9756     9756              
  Branches     2233     2233              
==========================================
+ Hits         3814     3816       +2     
  Misses       4885     4885              
+ Partials     1057     1055       -2     
# [Codecov](https://codecov.io/gh/Plume-org/Plume/pull/790?src=pr&el=h1) Report > Merging [#790](https://codecov.io/gh/Plume-org/Plume/pull/790?src=pr&el=desc) into [master](https://codecov.io/gh/Plume-org/Plume/commit/d99b42582d7a5a8c8087b6ebe067b944cae0c294&el=desc) will **increase** coverage by `0.02%`. > The diff coverage is `n/a`. ```diff @@ Coverage Diff @@ ## master #790 +/- ## ========================================== + Coverage 39.09% 39.11% +0.02% ========================================== Files 73 73 Lines 9756 9756 Branches 2233 2233 ========================================== + Hits 3814 3816 +2 Misses 4885 4885 + Partials 1057 1055 -2 ```
igalic reageerde 4 jaren geleden (Gemigreerd van github.com)

uh… will we need to add it as development dependency?

uh… will we need to add it as development dependency?
elegaanz (Gemigreerd van github.com) beoordeeld 4 jaren geleden
elegaanz (Gemigreerd van github.com) reageerde 4 jaren geleden

Shouldn't the repo URL be changed here?

Shouldn't the repo URL be changed here?
elegaanz reageerde 4 jaren geleden (Gemigreerd van github.com)

Also, maybe we could unify the headers in the changelog to follow what https://keepachangelog.com/ recommends, to keep it coherent.

And for the development dependency, I don't think so. It should be documented here that people who want to publish a new release should use this tool tho.

Also, maybe we could unify the headers in the changelog to follow what https://keepachangelog.com/ recommends, to keep it coherent. And for the development dependency, I don't think so. It should be documented [here](https://docs.joinplu.me/organization/release-process/) that people who want to publish a new release should use this tool tho.
igalic (Gemigreerd van github.com) beoordeeld 4 jaren geleden
igalic (Gemigreerd van github.com) reageerde 4 jaren geleden

how?

how?
elegaanz (Gemigreerd van github.com) beoordeeld 4 jaren geleden
elegaanz (Gemigreerd van github.com) reageerde 4 jaren geleden

To something like https://github.com/Plume-org/Plume/compare/{{tag_name}}...HEAD, so that the changelog links to our commit history.

To something like `https://github.com/Plume-org/Plume/compare/{{tag_name}}...HEAD`, so that the changelog links to our commit history.
elegaanz (Gemigreerd van github.com) beoordeeld 4 jaren geleden
elegaanz (Gemigreerd van github.com) reageerde 4 jaren geleden

Also, is there a <!-- next-url --> somewhere in the changelog you added? I can't find it.

Also, is there a `<!-- next-url -->` somewhere in the changelog you added? I can't find it.
igalic reageerde 4 jaren geleden (Gemigreerd van github.com)

n. b. : i've back-filled the changelog by copy-pasting the text from our github releases page

for the future of the changelog, i absolutely agree

n. b. : i've back-filled the changelog by copy-pasting the text from our github releases page for the future of the changelog, i absolutely agree
elegaanz reageerde 4 jaren geleden (Gemigreerd van github.com)

I know you copied what is on GitHub, but maybe we could change this text? Would it be a problem to have texts that are a bit different on Github and in the changelog? I would prefer to have the whole changelog have the same format (but that's arguable).

I know you copied what is on GitHub, but maybe we could change this text? Would it be a problem to have texts that are a bit different on Github and in the changelog? I would prefer to have the whole changelog have the same format (but that's arguable).
elegaanz reageerde 4 jaren geleden (Gemigreerd van github.com)

Also, could it be possible to add pre-release-hook to run crowdin pull (I don't remember the exact arguments, but basically : the command to pull the latest version of translations)? Or do you think it should be done manually before running cargo release?

Also, could it be possible to add `pre-release-hook` to run `crowdin pull` (I don't remember the exact arguments, but basically : the command to pull the latest version of translations)? Or do you think it should be done manually before running `cargo release`?
igalic reageerde 4 jaren geleden (Gemigreerd van github.com)

I know you copied what is on GitHub, but maybe we could change this text? Would it be a problem to have texts that are a bit different on Github and in the changelog? I would prefer to have the whole changelog have the same format (but that's arguable).

the only problem was time and energy
y'all have access to write to this PR, so, please, by all means, help me!!

Also, could it be possible to add pre-release-hook to run crowdin pull (I don't remember the exact arguments, but basically : the command to pull the latest version of translations)? Or do you think it should be done manually before running cargo release?

that's a very good idea!

how do i make it work?

◆ plume git:(fix/cargo-release-helper) ❯❯❯ crowdin pull
Project key is empty
✖ 1 plume git:(fix/cargo-release-helper) ❯❯❯ 
> I know you copied what is on GitHub, but maybe we could change this text? Would it be a problem to have texts that are a bit different on Github and in the changelog? I would prefer to have the whole changelog have the same format (but that's arguable). the only problem was time and energy y'all have access to write to this PR, so, please, by all means, help me!! > Also, could it be possible to add `pre-release-hook` to run `crowdin pull` (I don't remember the exact arguments, but basically : the command to pull the latest version of translations)? Or do you think it should be done manually before running `cargo release`? that's a very good idea! how do i make it work? ```shell ◆ plume git:(fix/cargo-release-helper) ❯❯❯ crowdin pull Project key is empty ✖ 1 plume git:(fix/cargo-release-helper) ❯❯❯ ```
elegaanz reageerde 4 jaren geleden (Gemigreerd van github.com)

I don't remember how the Crowdin CLI works, I'll check that and edit the PR. I'll also edit the changelog.

I don't remember how the Crowdin CLI works, I'll check that and edit the PR. I'll also edit the changelog.
elegaanz reageerde 4 jaren geleden (Gemigreerd van github.com)

So the translations should be pulled now, if you have a CROWDIN_API_KEY in your env. We should remember to document how to get one before making a release.

So the translations should be pulled now, if you have a `CROWDIN_API_KEY` in your env. We should remember to document how to get one before making a release.
igalic reageerde 4 jaren geleden (Gemigreerd van github.com)

So the translations should be pulled now, if you have a CROWDIN_API_KEY in your env. We should remember to document how to get one before making a release.

let's create a doc issue right now, and link it here

> So the translations should be pulled now, if you have a `CROWDIN_API_KEY` in your env. We should remember to document how to get one before making a release. let's create a doc issue right now, and link it here
elegaanz reageerde 4 jaren geleden (Gemigreerd van github.com)
https://github.com/Plume-org/docs/issues/88
igalic reageerde 4 jaren geleden (Gemigreerd van github.com)

what about docker?

what about docker?
elegaanz reageerde 4 jaren geleden (Gemigreerd van github.com)

I think the release should be automatic, I'll check.

I think the release should be automatic, I'll check.
elegaanz reageerde 4 jaren geleden (Gemigreerd van github.com)

It is not, I'll a hook.

It is not, I'll a hook.
elegaanz reageerde 4 jaren geleden (Gemigreerd van github.com)

The thing is, the docker tag needs to be pushed after the git tag, and there is no post-release-hook in cargo release, apparently.

So maybe we can document that this has to be done manually, and do it by hand for the moment?

The thing is, the docker tag needs to be pushed after the git tag, and there is no `post-release-hook` in cargo release, apparently. So maybe we can document that this has to be done manually, and do it by hand for the moment?
igalic reageerde 4 jaren geleden (Gemigreerd van github.com)

or we could add docker tag to the CI build process, only on tag

or we could add docker tag to the CI build process, only on tag
igalic reageerde 4 jaren geleden (Gemigreerd van github.com)

yunohost relies on docker, right?
and it's one of the platforms that we recommend, thru our installation guide

yunohost relies on docker, right? and it's one of *the* platforms that we recommend, thru our installation guide
elegaanz reageerde 4 jaren geleden (Gemigreerd van github.com)

It doesn't, it uses Bash scripts. I'm not sure if it is better tho… 😅

It doesn't, it uses Bash scripts. I'm not sure if it is better tho… :sweat_smile:
igalic (Gemigreerd van github.com) beoordeeld 4 jaren geleden
igalic (Gemigreerd van github.com) reageerde 4 jaren geleden

i didn't add it to our current changelog

i didn't add it to our current changelog
Eigenaar

We can tag to Docker images automatically by setting automate build properly.

We can tag to Docker images automatically by setting automate build properly.
Eigenaar

A test succeeded:
(v0.5.1-test2 was pushed by plumeorg)

A test succeeded: ![](https://i.gyazo.com/c2a284d00404574c60588d00365f61b4.png) (v0.5.1-test2 was pushed by plumeorg)
KitaitiMakoto heeft deze veranderingen 3 jaren geleden goedgekeurd
KitaitiMakoto heeft een reactie achtergelaten
Eigenaar

Remaining issue is how do we notify YunoHost maintainer. It is not an issue of cargo helper (this pul request's theme) but an issue of CI. So this pull request is ready to be merged.

Remaining issue is how do we notify YunoHost maintainer. It is not an issue of cargo helper (this pul request's theme) but an issue of CI. So this pull request is ready to be merged.
Eigenaar

Closed as #835

Closed as #835
KitaitiMakoto heeft deze pull request gesloten 3 jaren geleden

Reviewers

KitaitiMakoto heeft deze veranderingen 3 jaren geleden goedgekeurd
Deze pull-aanvraag kan niet opnieuw worden geopend omdat de branch is verwijderd.
Je kunt ook command line instructies bekijken.

Stap 1:

Vanuit het project, check een branch uit en test de veranderingen.
git checkout -b igalic/fix/cargo-release-helper master
git pull origin igalic/fix/cargo-release-helper

Stap 2:

Voeg de wijzigingen samen en update ze op Forgejo.
git checkout master
git merge --no-ff igalic/fix/cargo-release-helper
git push origin master
Log in om deel te nemen aan deze discussie.
Geen beoordelaars
Geen mijlpaal
Niet toegewezen
2 deelnemers
Notificaties
Vervaldatum
De deadline is ongeldig of buiten bereik. Gebruik het formaat 'jjjj-mm-dd'.

Geen vervaldatum ingesteld.

Afhankelijkheden

Geen afhankelijkheden ingesteld.

Referentie: Plume/Plume#790
Laden…
Er is nog geen inhoud.