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.

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

Add information about CI to README #343

Merged
merged 3 commits into from
Sep 9, 2021
Merged

Add information about CI to README #343

merged 3 commits into from
Sep 9, 2021

Conversation

alvicsam
Copy link
Collaborator

@alvicsam alvicsam commented Sep 8, 2021

Modified an image tag in README and also added information how to reproduce CI locally. We have several ci docker images with ready environment which can be used to build/test different projects. (Closes https://github.com/paritytech/ci_cd/issues/113)

Copy link
Contributor

@HCastano HCastano left a comment

Choose a reason for hiding this comment

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

I don't really see the point of this aside from the example Docker usage. The CI stage info is unnecessarily detailed, especially for the README. Why do you think the CI docs are worth adding?

@alvicsam
Copy link
Collaborator Author

alvicsam commented Sep 9, 2021

I thought that it might be useful for a developer to have a document describes how to reproduce CI locally. The CI stage info has a lot of details but it's hidden under collapsible section. If you think that this is too much for a readme I can suggest moving it to a separate document and put a link here.

@TriplEight
Copy link
Contributor

Yeah, everything in preparation is too broad, let's just publish it on https://github.com/paritytech/scripts/blob/master/README.md and link from here.

@HCastano HCastano changed the title added information about ci to readme Add information about CI to README Sep 9, 2021
Copy link
Contributor

@HCastano HCastano left a comment

Choose a reason for hiding this comment

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

Linking to the scripts repo is more appropriate.

I also just tried the Docker steps and everything works, so thanks for the PR!

@HCastano HCastano merged commit 9c159a5 into master Sep 9, 2021
@HCastano HCastano deleted the as-add-ci-docs branch September 9, 2021 20:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants