report: add workflow and documentation #448
Open
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
To break up the eco-gotests reporter into managable PRs, I have started with the templates for the report as a whole and the individual trees (branches). report_template.html is the entrypoint for viewing the reports and simply contains a list of the branches in the report along with links to the latest commit on each branch. tree_template.html is the report for an individual branch. It contains a tree listing out all of the specs under all of the subdirectories of tests/. Since it uses the native html details and summary tags it is entirely tab-navigable and fairly accessible. Both templates are fairly barebones with the intention being that future PRs may add more details as desired.
This PR contains about half of the report program as part of splitting it up into more managable PR sizes. It includes the following files: * `command.go`: Wrapper around executing local commands such as git and ginkgo. * `sum.go`: Small utility for getting the SHA-256 sum of the source code. * `template.go`: Contains types and functions for executing the report templates. * `tree.go`: Defines the SuiteTree type and methods for creating one from a Ginkgo report. The excluded files are necessary to actually run the program, namely the cache and main files. However, these combined are quite large and depend on all of the files from this PR.
This PR contains the rest of the report program. It includes the last two files not part of the last PR: * `cache.go`: Caches the trees generated from each branch and revision combination. Since a dry-run may take many minutes, caching allows the program to remain performant and responsive to changes in the templates without having to redo a dry-run. * `main.go`: Handles the command line flags and actual running of the program. It handles retrieving values from the cache or cloning and dry running as necessary. There are some small changes to the lint config and go.mod to allow the cache to be compressed. It uses a package already vendored so does not include additional dependencies. Compression is beneficial since the cache for the main branch alone may be over a megabyte in size but only ~40 KB when compressed. Excluded from this PR is the GitHub workflow to actually generate the report along with some high-level documentation.
sebrandon1
reviewed
Feb 18, 2025
| with: | ||
| path: ./report | ||
|
|
||
| - name: Save cached report data |
There was a problem hiding this comment.
Would this action fit this better? https://github.com/actions/upload-artifact
If I follow your job tasks you're trying to save the output right?
There was a problem hiding this comment.
The report itself is saved as an artifact a couple lines above but this step is just to save the report program's cache (currently just the outputs of dry-run on each branch). Since I'm using a constant cache key anyway it may not be much different than just using the upload artifact action with overwrite: true though
I could use an artifact instead so if you think it fits better for this use case I can switch over to it
The final PR in the series adding the initial version of the report program, this PR adds the GitHub workflow and documentation for the report program. Once merged, all pushes will update the report using the latest version of the program and templates.
klaskosk
force-pushed
the
ginkgo-report-workflow-docs
branch
from
02bc8d2 to
cf44680
Compare
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.
Depends-on: #447
The final PR in the series adding the initial version of the report program, this PR adds the GitHub workflow and documentation for the report program. Once merged, all pushes will update the report using the latest version of the program and templates.
This is PR 4/4. An example report can be seen on my GitHub pages.