feat: Markdown linting and mkdocs build #65
Merged
jon_nfc
merged 36 commits from 2022-01-24 05:45:46 +00:00
12-15-mkdocs-build-markdown-linting
into development
No Reviewers
Labels
Clear labels
Bug
Used in discussion about a bug in comments or commits
CVE-2023-5764
Denotes items related to the CVE
CodeReview
Used in comments (issues/MR/commits) to denote code review related items
Documentation
Documentation items
Feature
Used in discussion about a Feature in comments or commits
Lint
Used in comments (issues/MR/commits) to denote lint tasks todo, done, fixed
Privacy
Used in comments (issues/MR/commits) to denote privacy related items
Security
Used in comments (issues/MR/commits) to denote Security related items
breaking-change
label used to denote that the issue/Merge Request does/will introduce a breaking change
bug::reproducable
Given to an issue when the bug has been confirmed as re-producable. Can also be used in comments and commits.
bug::unable to reproduce
Given to an issue when the bug that is not able to be reproduced. Can also be used in comments and commits.
code review::complete
code review::not started
code review::rejected
code review::underway
difficulty::Full Development
Level 3. Difficulty representing that the task to complete must be planned and created.
difficulty::Good First Issue
Level 1. Difficulty representing that the task is very simple and with limited knowledge can be completed.
difficulty::Prior Knowledge
Level 2. Difficulty representing that the task requires some prior knowledge of either the technology or the project for task completion.
documentation::complete
Issues, Merge Requests
documentation::no change required
Issues, Merge Requests and used to denote no documentation changes required
documentation::not started
Issues, Merge Requests
documentation::stalled
Issues, Merge Requests
documentation::underway
Issues, Merge Requests
impact::0
impact::1
impact::2
impact::3
impact::4
impact::5
ops::ansible-roles
OPS project tag
ops::automation
ops::gitlab-ci
OPS project tag
ops::marcas
OPS project tag
ops::python-gitlab-management
OPS project tag
ops::website
priority::0
priority::1
priority::2
priority::3
priority::4
priority::5
stage::Ready for Development
stage::develop
Stage for use in Issues and Merge Requests. Can also be used in discussion in comments and commits
stage::feedback required
stage::planning
Stage for use in Issues and Merge Requests. Can also be used in discussion in comments and commits
stage::test
Stage for use in Issues and Merge Requests. Can also be used in discussion in comments and commits
stale
Label given to issues/merge requests that are considered stale due to no collaboration and is a mark for closure.
triage
Tag given to issues/merge requests requiring triaging by the team.
triage::not_confidential
This tag is given by the triage bot so that URLs can be added to an issue/comment. A triage policy for NFC wide should remove this label.
type::CI / CD
type::automation
This type is used to denote an automation job
type::bug
Type for Issues and Merge Requests. Can also be used in discussion in comments and commits
type::compliance
type::discussion
Type for Issues. Can also be used in discussion in comments.
type::documentation
Type for Issues and Merge Requests. Can also be used in discussion in comments and commits
type::feature
type for Issues and Merge Requests. Can also be used in discussion in comments and commits
type::invalid
label given to tickets that require no action or are deem as invalid.
type::quality assurance
Type for Issues and Merge Requests. Can also be used in discussion in comments and commits
type::question
Type for Issues. Can also be used in discussion in comments.
type::security
Type for Issues and Merge Requests.
type::specification
Design specification
workflow::complete
Issues, Merge Requests
workflow::not ready
workflow::not ready::blocked
workflow::not started
Issues, Merge Requests
workflow::ready to commence
Issues, Merge Requests
workflow::stalled
Label given to issues/merge requests where no work has occured in x days iaw triage policy.
workflow::underway
Issues, Merge Requests
workflow::underway::develop
Area/CI-CD
Documentation changes
Area/Documentation
Documentation changes
Area/Security
This is security issue
Area/Testing
Issue or pull request related to testing
Bug
Failure to Confirm
Bug exists due to not confirming/testing code
Bug
Regression
THe bug is a regression of a feature
Bug
To be Confirmed
This bug is not confirmed
Bug
Unable to Reproduce
A developer can not re-create/re-produce the bug
Compat/Breaking
Breaking change that won't be backward compatible
Impact
Critical
1
The impact is critical in that it is blocking or prevents usage.
Impact
High
2
The impact requires that changes be made for continuted usage.
Impact
Low
4
The impact requires the user approach from a different angle for continued usage.
Impact
Medium
3
The impact requires a workaround for continued usage.
Impact
Very Low
5
The impact has a slight effect on usage.
Priority
High
2
The priority is high
Priority
Low
4
The priority is low
Priority
Medium
3
The priority is medium
Priority
Very High
1
The priority is critical
Priority
Very Low
5
The priority is very low
Reviewed
Confirmed
1
Issue has been confirmed
Reviewed
Duplicate
2
This issue or pull request already exists
Reviewed
Invalid
3
Invalid issue
Reviewed
Won't Fix
3
This issue won't be fixed
Status
Abandoned
3
Somebody has started to work on this but abandoned work
Status
Blocked
1
Something is blocking this issue or pull request
Status
Need More Info
2
Feedback is required to reproduce issue or to continue work
Type
Bug
Something is not working
Type
Epic
Epic User Story
Type
Feature
Feature / Module
Type
Incident
Something occured related to a service
Type
RFE
Request for Enhancement
Type
Task
A work item that must be done
Urgency
Low
4
Prioritize this amoungst your list of things to do.
Urgency
Major
1
Urgency is so high it should have been dealt with last week.
Urgency
Medium
3
Start as soon as possible.
Urgency
Very High
2
Urgency is high enough to warrant near immediate commencement.
Urgency
Very Low
5
Add this to your list of things to do.
Projects
Clear projects
No project
Notifications
Due Date
No due date set.
Dependencies
No dependencies set.
Reference: infrastructure/gitlab-ci#65
Reference in New Issue
Block a user
Blocking a user prevents them from interacting with repositories, such as opening or commenting on pull requests or issues. Learn more about blocking a user.
No description provided.
Delete Branch "12-15-mkdocs-build-markdown-linting"
Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?
🔗 References
closes #12
closes #15
required for nofusscomputing/ops#41
✅ Tasks
#12 closed in commit message
#15 closed in commit message
requested review from @jon_nfc
assigned to @jon_nfc
added 1 commit
Compare with previous version
added 1 commit
bc67e939
- chore: initial add of build and validation jobs for mkdocs and markdown lintingCompare with previous version
added 2 commits
954aa28d
- feat(validation): Added a Markdown linting validation job.50b5e854
- feat(build): initial add of mkdocs build jobCompare with previous version
added 2 commits
6383cde3
- docs(markdown_lint): initial adding of the docs5c05ed76
- docs(mkdocs): initial adding of mkdocs build readme.Compare with previous version
added 2 commits
6363ea37
- docs(markdown_lint): completed the job docs.1ef0e224
- docs(mkdocs): Completed the mkdocs build readmeCompare with previous version
marked the checklist item #12 closed in commit message as completed
marked the checklist item #15 closed in commit message as completed
mentioned in issue #15
mentioned in issue #12
issues #12 and #15 marked as ~"workflow::complete"
added 2h 46m of time spent
set build artifacts to expire after 24 hours
figure out how to use package json so that versions can be checked by ci
Consider adding mkdocs to a requirements file for version checking ci job
Cleanup, not required
Check this post https://stackoverflow.com/a/38902183 as it provides an example.
and
How to specify path npm --prefix /path/to/project. Idea is that it will have the deps for the job for a version check to be included
added 30m of time spent
added 1 commit
347597e3
- docs(mkdocs_build): include mandatory vars in template ci file.Compare with previous version
changed this line in version 7 of the diff
added 1 commit
e0d8885d
- ci(artifacts): markdown lint and mkdocs build artifacts to expire after 24 hoursCompare with previous version
changed this line in version 8 of the diff
added 1 commit
21159643
- chore: review fixes.Compare with previous version
dependency scanning
Add to .gitlab-ci.yml
added 25m of time spent
licence scanning
Needs a test stage
needs a test stage
added 15m of time spent
added 1 commit
5c872f16
- ci: Added a test stage for gitlab specific tests.Compare with previous version
Add new jobs here
added 1 commit
fc816192
- ci(scanners): Added dependency and licence scannersCompare with previous version
Added
Added
added 1 commit
7665e512
- chore: add mkdocs dir for pip file.Compare with previous version
added 1 commit
5a41962a
- feat(mkdocs_build): move ci job dependencies to a pip file so that the ci...Compare with previous version
added 1 commit
83cce72a
- ci(licence_finder): set to recursive scan so all licence's can be detected.Compare with previous version
changed this line in version 14 of the diff
changed this line in version 14 of the diff
changed this line in version 14 of the diff
changed this line in version 14 of the diff
added 1 commit
18c2e231
- chore(mkdocs): move mkdocs jobs to its own directory.Compare with previous version
Done
changed this line in version 15 of the diff
changed this line in version 15 of the diff
changed this line in version 15 of the diff
added 1 commit
906f09e2
- feat(mkdocs_build): use a pip file for job so that licence scanning can function.Compare with previous version
added 1h 5m of time spent
added 1 commit
e1894ec0
- fix(dependency_scanning): upgraded versions from vulnerability scan.Compare with previous version
added 12m of time spent
Typo for pillow
added 1 commit
484d9879
- fix(ansible): fix typo in job pip fileCompare with previous version
added 10m of time spent
changed this line in version 18 of the diff
added 1 commit
0df60b12
- fix(ansible): remove duplicate lines that last code review didn't remove.Compare with previous version
Figure out why lines 1-3 make the check job fail
added 10m of time spent
added 1 commit
e46dc57b
- chore(markdown_lint): add empty junit test file.Compare with previous version
added 1 commit
9ab336fb
- feat(markdown_lint): include junit configuration file '.markdownlint-cli2.jsonc' in ci job.Compare with previous version
added 1 commit
fd48316a
- docs(markdown_lint): updated docs on how to use and view rules.Compare with previous version
added 33m of time spent
changed this line in version 22 of the diff
added 1 commit
6668c2fb
- refactor: test specifying must equal.Compare with previous version
added 1 commit
2fffa866
- ci(python_dependency_scan): disabled main job and manual setup for all ci jobs.Compare with previous version
Not needed
changed this line in version 24 of the diff
added 1 commit
41c5e0ca
- chore: remove dependency scan rules not requiredCompare with previous version
changed this line in version 25 of the diff
changed this line in version 25 of the diff
changed this line in version 25 of the diff
added 1 commit
b8440832
- chore: test wich path works for specifying pip file.Compare with previous version
mentioned in issue gitlab-org/gitlab#350949
Failed dep scan jobs bug reported at gitlab-org/gitlab#350949
added 1 commit
725bfaf8
- ci: debug logging for dep scanningCompare with previous version
added 1 commit
Compare with previous version
added 1 commit
996ee64a
- ci(dependency_scanning): scanner set to use python 3.6Compare with previous version
added 1 commit
7153f9b4
- ci(dependency_scanning): check python version as pillow 9.0 reported as not found.Compare with previous version
added 1 commit
a6afa766
- ci(dependency_scanning): increase python version to 3.7Compare with previous version
added 1 commit
Compare with previous version
added 2 commits
4e1da5e8
- ci(dependency_scanning): python 3.7 not available for dependecy scanning.Compare with previous version
added 2 commits
39a76a08
- ci(dependency_scanning): delete all python 'requirements.txt' files that are...a2d705de
- ci(mkdcos): mkdocs requirements.txt had a '\n' in the filename. renamed.Compare with previous version
didnt work. scrap idea until npm is learned.
update issue with workaround.
added 2h 37m of time spent
disabled due to gitlab-org/gitlab#350949
no longer required as it's included in the ci job to copy to root of the repository.
changed this line in version 34 of the diff
added 1 commit
b6dcb47b
- docs(markdown_lint): removed no longer needed requirement.Compare with previous version
added 1 commit
Compare with previous version
added 1 commit
3096d7ee
- ci(markdown_lint): Added Linting of Markdown for files in this repository.Compare with previous version
done https://gitlab.com/gitlab-org/gitlab/-/issues/350949#note_819013439
resolved all threads
added 27m of time spent
added 10m of time spent
mentioned in commit
e0d8885d52
mentioned in commit
fc816192be
mentioned in commit
347597e3c1
mentioned in commit
7665e512a5
mentioned in commit
5c872f163e
mentioned in commit
6383cde3bf
mentioned in commit
5c05ed7605
mentioned in commit
954aa28dbf
mentioned in commit
50b5e8542b
mentioned in commit
1ef0e2245f
mentioned in commit
bc67e939fa
mentioned in commit
5a41962a99
mentioned in commit
83cce72af2
mentioned in commit
906f09e2d3
mentioned in commit
d71def2f2a
mentioned in commit
484d98792a
mentioned in commit
e1894ec0c4
mentioned in commit
0df60b12db