Skip to content
This repository has been archived by the owner on Oct 11, 2024. It is now read-only.

Add CI for linting docs #998

Closed
wants to merge 3 commits into from
Closed

Add CI for linting docs #998

wants to merge 3 commits into from

Conversation

meain
Copy link
Member

@meain meain commented Sep 30, 2022

Description

Adds a new CI job to lint docs. As of now, the cli docs are only linted if there is change in the src files (ref). This PR also removes the CI action to automatically generate docs and commits to codebase.

It does not include the push to s3, I'll pick that up in a follow up PR along for #571 .

Once this PR is merged, the branch on filecheck action (ref) will have to be changed to main in a follow up PR.

Type of change

  • 🌻 Feature
  • 🐛 Bugfix
  • 🗺️ Documentation
  • 🤖 Test
  • 💻 CI/Deployment
  • 🐹 Trivial/Minor

Issue(s)

Test Plan

  • 💪 Manual
  • ⚡ Unit test
  • 💚 E2E

@meain meain temporarily deployed to Testing September 30, 2022 10:36 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 10:36 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 10:36 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:00 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:01 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:01 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:06 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:06 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:06 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:16 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:40 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:41 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:41 Inactive
@meain meain temporarily deployed to Testing September 30, 2022 11:51 Inactive
.github/workflows/docs-ci.yml Outdated Show resolved Hide resolved
.github/workflows/_filechange_checker.yml Show resolved Hide resolved
.gitignore Show resolved Hide resolved
@meain meain temporarily deployed to Testing October 4, 2022 09:04 Inactive
@sonarqubecloud
Copy link

sonarqubecloud bot commented Oct 4, 2022

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
No Duplication information No Duplication information

@meain
Copy link
Member Author

meain commented Oct 4, 2022

I've rebased the PR against current master to fix conflicts and squashed the intermediate commits. Let me know if there is anything else needed in the PR.

@meain meain temporarily deployed to Testing October 4, 2022 09:04 Inactive
@meain meain temporarily deployed to Testing October 4, 2022 09:18 Inactive
@meain meain temporarily deployed to Testing October 4, 2022 10:05 Inactive
@meain meain temporarily deployed to Testing October 4, 2022 10:05 Inactive
@meain meain temporarily deployed to Testing October 4, 2022 10:05 Inactive
@meain
Copy link
Member Author

meain commented Oct 5, 2022

I've reworked and combined all of this logic into a single ci jobs in #1052. Since this is not merged, closing this in favor of that.

@meain meain closed this Oct 5, 2022
@meain meain deleted the docs-ci branch October 25, 2022 06:42
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants