Fix modified dates in docs #2478
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
cpholguera
requested changes
Jan 9, 2024
There was a problem hiding this comment.
Thanks @philyoosays! Here a couple of suggestions. Apart from that I'm just worried about the time that it takes to retrieve all data for all files (which can be hundreds). Let's discuss on Slack.
src/scripts/git_data.py
Outdated
|
|
||
| if GITHUB_TOKEN is None: | ||
| print('Github token not found') | ||
| return get_last_commit_date_by_terminal_log(file_path) |
There was a problem hiding this comment.
we can get rid of that function and return None or "N/A" here.
.github/workflows/build-website.yml
Outdated
| @@ -21,7 +21,9 @@ jobs: | |||
|
|
|||
| - run: ./src/scripts/structure_mastg.sh | |||
|
|
|||
| - run: python3 src/scripts/transform_files.py | |||
| - env: | |||
There was a problem hiding this comment.
It might work without this. The GITHUB_TOKEN is created automatically on each run and should be accessible to the script via env.
There was a problem hiding this comment.
Let's try. We can always revert the commit that removes this declaration
Co-authored-by: Carlos Holguera <[email protected]>
…wasp-mastg into fix-modified-dates-in-docs
Co-authored-by: Carlos Holguera <[email protected]>
…wasp-mastg into fix-modified-dates-in-docs
Co-authored-by: Carlos Holguera <[email protected]>
Co-authored-by: Carlos Holguera <[email protected]>
…wasp-mastg into fix-modified-dates-in-docs
Co-authored-by: Carlos Holguera <[email protected]>
…wasp-mastg into fix-modified-dates-in-docs
|
Fixed with depth=0 in #2564 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a fetch to the Github REST API to collect the last modified date for commits to MASTG markdown files for display in the MASTG mkdocs site.
As a fallback in case the
GITHUB_TOKENwas not able to be retrieved from the Github Actions pipeline, the original code to get last modified dates was preserved and called.Issue
The issue being fixed has to do with the last modified dates being incorrect in the published mkdocs site. It seems that the Github Actions pipeline is copying the files and the original code that determines the last modified dates is using the local terminal
git logmethod to determine last modified date. This is causing all the files to have the same last modified date (date of merge to master for any file) that does not match the actual last modified dates for the files in the repository.The Fix
To be sure that we have an accurate commit history, this fix uses the Github REST API to fetch the commit history for each markdown file from the repository.
Note To Maintainers: Please make sure that the
GITHUB_TOKENhas read access to content.Thank you for submitting a Pull Request to the OWASP MASTG. Please make sure that:
If your PR is related to an issue. Please end your PR test with the following line:
This PR closes #< insert number here >.