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

docs(repo): add gitlab instructions to ci docs #2221

Merged
merged 1 commit into from
Aug 8, 2022

Conversation

snim2
Copy link
Contributor

@snim2 snim2 commented Jul 27, 2022

Checklist

  • Tests added / updated
  • Docs added / updated

Does this PR introduce a breaking change?

  • Yes
  • No

@snim2 snim2 requested a review from a team as a code owner July 27, 2022 21:57
philsturgeon
philsturgeon previously approved these changes Aug 1, 2022
@philsturgeon philsturgeon enabled auto-merge (squash) August 1, 2022 18:17
@snim2 snim2 changed the title Add GitLab instructions to CI docs docs(ci): Add GitLab instructions to CI docs Aug 1, 2022
@snim2
Copy link
Contributor Author

snim2 commented Aug 1, 2022

I've changed the PR title to try to match the expectations of the lint. I'm not sure that those dead link errors are from my changes though, and I don't have permissions to re-run the actions :)

@philsturgeon
Copy link
Contributor

philsturgeon commented Aug 2, 2022

Thank you for this change, lets try and get it merged. The commit is failing because commits need to match the same convention as the PR titles, so if you could amment your commit to slap docs(ci): at the front then force push that should get it working.

git commit --amend -m "docs(ci): add gitlab instructions to ci docs"

@snim2
Copy link
Contributor Author

snim2 commented Aug 3, 2022

Hmm, so it looks like docs is an invalid scope? scope must be one of [repo, test-harness, deps-dev, cli, core, formats, functions, parsers, ref-resolver, ruleset-bundler, ruleset-migrator, rulesets, runtime] [scope-enum]

@philsturgeon
Copy link
Contributor

Ok, sorry about all this, some recent changes have made this a bit hectic and we need to see if we can loosen the strictness of this linting.

git commit --amend -m "docs(repo): add gitlab instructions to ci docs"

This should work. It likes things lowercase, and it needs the right "scope", so can be any of those scopes it suggests: rulesets, core, etc. Repo seems close enough.

@philsturgeon philsturgeon changed the title docs(ci): Add GitLab instructions to CI docs docs(repo): add gitlab instructions to ci docs Aug 5, 2022
auto-merge was automatically disabled August 5, 2022 14:50

Head branch was pushed to by a user without write access

Copy link
Contributor

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

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

Left a couple comments with small changes, thanks for putting this together!

when: always
reports:
junit: $CI_PROJECT_DIR/spectral-report.xml
expire_in: 2 weeks
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not very familiar with GitLab CI/CD but I tried to copy/paste this script and it was throwing an error for expire_in. I checked their docs and it looks like that property needs to be under artifacts instead of reports maybe?

docs/guides/8-continuous-integration.md Outdated Show resolved Hide resolved
@snim2
Copy link
Contributor Author

snim2 commented Aug 7, 2022

OK, because of the issue with the commit message, I've forced-pushed a squashed commit which includes the requested changes.

Copy link
Contributor

@heitortsergent heitortsergent left a comment

Choose a reason for hiding this comment

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

Thanks for making the changes! :shipit:

@philsturgeon philsturgeon enabled auto-merge (squash) August 8, 2022 16:12
@philsturgeon philsturgeon merged commit 05ee443 into stoplightio:develop Aug 8, 2022
@snim2 snim2 deleted the add-gitlab-docs branch August 9, 2022 16:13
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.

None yet

3 participants