[#1771] Add tip on generating report via reposense-action (#1858)

tlylt · web-flow · commit 1a7ff78bd0a9 · 2023-01-22T20:57:57.000+08:00
Generating RepoSense reports via GitHub Actions requires forking of the
template publish-RepoSense repo. It also only supports publishing with
GitHub Pages.

This process is more complicated than utilizing published actions on the
marketplace. It also requires direct edits to the script files for more
customization.

Let's document an available alternative via a community-published action
for interested users to explore.

The published action can be used in the same directory as the user's
project and support customization via action arguments. It also supports
surge.sh as an alternative publishing platform.
diff --git a/docs/ug/withGithubActions.md b/docs/ug/withGithubActions.md
@@ -34,6 +34,12 @@ You can use [_GitHub Actions_](https://github.com/features/actions) (together wi
 
 To access your regenerated RepoSense report, go to the settings of your fork in GitHub, under **GitHub Pages** section, look for `Your site is published at [LINK]`. It should look something like `https://[YOUR_GITHUB_ID].github.io/publish-RepoSense`.
 ![GitHub Setting](../images/publishingguide-githubsetting.jpg "GitHub Setting")
+
+<box type="tip" seamless>
+
+There is also a published GitHub Action ([reposense-action](https://github.com/marketplace/actions/reposense-action)) that can be used to generate and publish RepoSense reports. It is especially convenient for users who wish to skip the forking and setting up of a separate repository. For more information, refer to the [usage description](https://github.com/marketplace/actions/reposense-action#usage).
+</box>
+
 </div>
 
 <!-- ==================================================================================================== -->
