#790 cargo release helper

Open
igalic wants to merge 7 commits from igalic/fix/cargo-release-helper into master
igalic commented 5 months ago (Migrated from 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] commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner

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

uh… will we need to add it as development dependency?
elegaanz (Migrated from github.com) reviewed 5 months ago
Plume_migration_agent commented 5 months ago

Shouldn’t the repo URL be changed here?

Shouldn't the repo URL be changed here?
elegaanz commented 5 months ago (Migrated from github.com)
Owner

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 (Migrated from github.com) reviewed 5 months ago
elegaanz (Migrated from github.com) reviewed 5 months ago
Plume_migration_agent commented 5 months ago

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 (Migrated from github.com) reviewed 5 months ago
Plume_migration_agent commented 5 months ago

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 commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner
https://github.com/Plume-org/docs/issues/88
igalic commented 5 months ago (Migrated from github.com)
Owner

what about docker?

what about docker?
elegaanz commented 5 months ago (Migrated from github.com)
Owner

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

I think the release should be automatic, I'll check.
elegaanz commented 5 months ago (Migrated from github.com)
Owner

It is not, I’ll a hook.

It is not, I'll a hook.
elegaanz commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner

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 commented 5 months ago (Migrated from github.com)
Owner

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 (Migrated from github.com) reviewed 5 months ago
Plume_migration_agent commented 5 months ago

i didn’t add it to our current changelog

i didn't add it to our current changelog
This pull request can be merged automatically.
You are not authorized to merge this pull request.
This branch is out-of-date with the base branch
Sign in to join this conversation.
No reviewers
No Milestone
No Assignees
1 Participants
Notifications
Due Date

No due date set.

Dependencies

This pull request currently doesn't have any dependencies.

Loading…
There is no content yet.