Update README.md to add snapshot action generation entry #399
Conversation
README.md
Outdated
| @@ -164,6 +164,12 @@ allprojects { | |||
|
|
|||
| - Update the version of mistica to the one the snapshot was released with, sync your project and the dependency should be resolved with the artifact including your local changes. | |||
|
|
|||
| ## Snapshot generation with GitHub Action | |||
| This is another option to generate a snapshot version available for all applications. Just navigate to [the snapshot.yml workflow within Actions](https://github.com/Telefonica/mistica-android/actions/workflows/snapshot.yml), select a branch and enter the version like | |||
| ``` x.x.x-snapshot ``` | |||
There was a problem hiding this comment.
minor: SNAPSHOT in uppercase
Co-authored-by: Jose Rubio <[email protected]>
| @@ -164,6 +164,12 @@ allprojects { | |||
|
|
|||
| - Update the version of mistica to the one the snapshot was released with, sync your project and the dependency should be resolved with the artifact including your local changes. | |||
|
|
|||
| ## Snapshot generation with GitHub Action | |||
| To create a new snapshot go to [the snapshot.yml Action](https://github.com/Telefonica/mistica-android/actions/workflows/snapshot.yml), select a branch and enter the version, like | |||
There was a problem hiding this comment.
Perhaps we could also add the text: press Run workflow before selecting a branch.
Even though it seems quite obvious, but idk, it's just in case.
README.md
Outdated
| @@ -164,6 +164,12 @@ allprojects { | |||
|
|
|||
| - Update the version of mistica to the one the snapshot was released with, sync your project and the dependency should be resolved with the artifact including your local changes. | |||
|
|
|||
| ## Snapshot generation with GitHub Action | |||
| To create a new snapshot go to [the snapshot.yml Action](https://github.com/Telefonica/mistica-android/actions/workflows/snapshot.yml), select a branch and enter the version, like | |||
| ``` x.x.x-SNAPSHOT ``` | |||
There was a problem hiding this comment.
after having reviewed the code, you don't need to write "SNAPSHOT". That suffix is added later on
Line 46 in 0fc068f
I would specify that. The version must be entereed without the snapshot suffix
README.md
Outdated
| ``` x.x.x ``` | ||
|
|
||
| After a while, the new version will be available! |
There was a problem hiding this comment.
I would still mention "SNAPSHOT" suffix somewhere. What I meant in my previous comment was that setting the suffix was not required by the workflow. However I would still specify that the release is published with the mentioned SNAPSHOT suffix. Sorry for the misunderstanding
There was a problem hiding this comment.
Done, it is no problem
🥅 What's the goal?
We need another entry in the README.md to give visibility to the snapshot action.
🚧 How do we do it?
Edit the README.md.
🧪 How can I test this?
The only thing necessary is checking out README.md.