Skip to content
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.

Sign up for GitHub

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

Update README.md to add snapshot action generation entry #399

Merged
merged 5 commits into from
Nov 26, 2024
Merged

Update README.md to add snapshot action generation entry #399

Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a6837bc
Update README.md to add snapshot action generation entry
jmanriquehiberus Nov 26, 2024
d85eff8
Apply suggestions from code review
jmanriquehiberus Nov 26, 2024
6c6e7b6
Update README.md
jmanriquehiberus Nov 26, 2024
55e9abf
Update README.md
jmanriquehiberus Nov 26, 2024
39e310c
Update README.md
jmanriquehiberus Nov 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Contributor

@jeprubio jeprubio Nov 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

``` x.x.x-SNAPSHOT ```
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

after having reviewed the code, you don't need to write "SNAPSHOT". That suffix is added later on

mistica-android/build.gradle

Line 46 in 0fc068f

version = System.getProperty("SNAPSHOT_VERSION")+"-SNAPSHOT"

I would specify that. The version must be entereed without the snapshot suffix

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done


After a while, the new version will be available!

## Design tokens
We have several tokens that are defined by the UX team (colors, radius and text presets) in a [JSON format](https://github.com/Telefonica/mistica-design/tree/production/tokens). Using these files, we generate XML and Kotlin files that are used in the library.

Expand Down
Loading