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

some README updates #483

Merged
merged 7 commits into from
Apr 29, 2021
Merged

Conversation

casperdcl
Copy link
Contributor

@casperdcl casperdcl commented Apr 27, 2021

Fixes #482

- badges
- more emphasis on setup-cml than docker
README.md Outdated Show resolved Hide resolved
- also prevents pre-commit hook from incorrectly reflowing
@casperdcl
Copy link
Contributor Author

btw npm run test surely should skip tests which need a token (at least on external PRs)?

README.md Outdated Show resolved Hide resolved
@0x2b3bfa0
Copy link
Member

0x2b3bfa0 commented Apr 27, 2021

btw npm run test surely should skip tests which need a token (at least on external PRs)?

Yes, it's a known issue on our current testing setup (#183). We should either skip them for external pull requests or just run them on every pull request after asking for human approval through GitHub Environments.

Anyhow, maybe we should separate unit tests from acceptance tests for a better contribution experience.

@casperdcl casperdcl closed this Apr 27, 2021
@casperdcl casperdcl deleted the update-readme branch April 27, 2021 15:49
@casperdcl casperdcl restored the update-readme branch April 27, 2021 15:49
@casperdcl casperdcl reopened this Apr 27, 2021
@0x2b3bfa0

This comment has been minimized.

[docs about configuring CML with GitLab](https://github.com/iterative/cml/wiki/CML-with-GitLab).
- **Bitbucket Cloud users**: Please see our
[docs on CML with Bitbucket Cloud](https://github.com/iterative/cml/wiki/CML-with-Bitbucket-Cloud).
_Bitbucket Server support estimated to arrive by May 2021._
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I changed this from "Jan 2021" to "May 2021" but idk if that's still too ambitious :)

Copy link
Member

Choose a reason for hiding this comment

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

I think that we actually support BitBucket to some extent.

🔔 @DavidGOrtega?

README.md Show resolved Hide resolved
@casperdcl casperdcl self-assigned this Apr 29, 2021
@casperdcl casperdcl added the documentation Markdown files label Apr 29, 2021
@0x2b3bfa0 0x2b3bfa0 changed the base branch from master to release/v0.3.7 April 29, 2021 16:14
@0x2b3bfa0
Copy link
Member

@casperdcl, is this ready for merging?

@0x2b3bfa0 0x2b3bfa0 merged commit e98c91b into iterative:release/v0.3.7 Apr 29, 2021
@casperdcl casperdcl deleted the update-readme branch April 29, 2021 22:50
@casperdcl casperdcl mentioned this pull request Apr 29, 2021
0x2b3bfa0 pushed a commit that referenced this pull request Apr 29, 2021
* some README updates

- badges
- more emphasis on setup-cml than docker

* fix yaml -> bash

- also prevents pre-commit hook from incorrectly reflowing

* readme: update badge label

* em-dash

* readme: more copyedits

* docs: more readme clarifications

* better emoji support
@casperdcl casperdcl restored the update-readme branch April 30, 2021 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Markdown files
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: make GHA default, docker optional
2 participants