docs
actions-gh-pages
docs | actions-gh-pages | |
---|---|---|
5 | 14 | |
67 | 4,451 | |
- | - | |
9.0 | 8.6 | |
7 days ago | 8 days ago | |
JavaScript | TypeScript | |
MIT License | MIT License |
Stars - the number of stars that a project has on GitHub. Growth - month over month growth in stars.
Activity is a relative number indicating how actively a project is being developed. Recent commits have higher weight than older ones.
For example, an activity of 9.0 indicates that a project is amongst the top 10% of the most actively developed projects that we are tracking.
docs
-
Job Seekers Worksheet: Build Your Resume with Open Source
Feel free to share and adapt this worksheet. We super stoked that @codergirl1991 is working on an issue for how to use OpenSauced for job seekers. So if there's more you'd like to see, let us know!
-
What to do when your PR fails
Yesterday, I decided to make some "quick" changes to the OpenSauced docs site. Now, I know that "quick changes" is essentially a bad word in tech. Anytime you say it, it will indeed not be quick. I wrote up a quick issue that described reorganizing a couple of things and adding a quick intro page. I made the changes, wrote the page, pushed my changes, and made the Pull Request (PR), only to see that I failed. Ugh. It was quick, but it wasn't right. Not really having the time to dig into it, I left my PR open and determined to get back to it the next day. Understanding why a project is failing may look different depending on how it is set up. For us, we're going to look at implementation errors, compliance issues, check the deploy log.
-
Strategies for Successful Contributor Onboarding
At OpenSauced, we’ve been working to curate a contributor journey that allows for contributors to grow. We have repositories made for new contributors, like our Intro Course, pizza-verse, and guestbook. We also include good first issue labels on some of the issues in our app, which is generally geared towards someone leaving the new stage and entering the intermediate stage. In the same way, our docs repo has a variety of issues open to different levels. And finally, there’s always space for our expert contributors across the repositories.
-
Generate PDF handbook with Docusaurus using GitHub Actions
Yaml file link: @open-sauced/docs.opensauced.pizza/main/.github/workflows/release.yml
-
How to lint PRs and welcome contributors using GitHub Actions
The full workflow is available here: .github/workflows/compliance.yml
actions-gh-pages
-
Where can I host a basic HTML page? Free.
Check out the GitHub action you can use for deploying to GitHub pages: https://github.com/peaceiris/actions-gh-pages.
-
Share rust docs
In addition to just sharing the .html generated files which would likely be cumbersome, you can host the docs on github pages and use something like https://github.com/peaceiris/actions-gh-pages + github actions to upload the documentation from your private repository to a public repo (required for non paid users).
-
The strongest principle of the blog's growth lies in the human choice to deploy it
I started by using runs-on: ubuntu-22.04 in this workflow to check if everything works ok. It run without any issues. After that I created PRs to add support for ubuntu-22.04 and ubuntu-latest version to GitHub Actions for Hugo and GitHub Pages Action
-
PSA: If you're using gh-pages to host your CI-generated documentation, make sure you don't store any history for that branch
As a first-step measure, we changed the CI script to overwrite the gh-pages branch at every run, rather than just appending a new commit. We use this gh-pages action, so it was just a matter of adding a force_orphan: true parameter.
-
How I created my Portfolio website using Hugo and GitHub pages?
Interesting to note that GitHub stores this workflow in the "main" branch under .github/workflows folder. For more details on this Action please refer the documentation and code at https://github.com/peaceiris/actions-gh-pages.
-
Preview Pull Requests and Automated CI/CD
My first workflow is to build and deploy or preview Client, It runs whenever a push or pull request creates for main branch containing changes to the code of client. It install dependencies and builds vue.js app. After build I use peaceiris/actions-gh-pages to deploy it to Github Pages. If the event is Pull Request then deploy to a sub-directory named preview and commit hash and leave a comment on PR.
-
GitHub Actions Reporting My ❤️ Music
If the data fetch from previous step succeeds, the workflow continues by building the static website with Hugo. Hugo is setup using action peaceiris/actions-hugo. When the files are ready, the result is published to GitHub pages, using another GitHub action, peaceiris/actions-gh-pages.
-
Generate PDF handbook with Docusaurus using GitHub Actions
peaceiris/actions-gh-pages@v3 - deploys any folder(s) to gh-pages, can use it for multiple static endpoints
-
Deploy Hugo website using Github pages
For more information about the actions used and their options, please see Hugo and Github pages on Github.
-
Automating the building and deployment of GitHub Pages
This quote is quite true. Without automation, we would spend a lot of out time on things that would have to be done repetitively, for example, manually building and deploying your GitHub pages every time there is a change. Luckily, you can easily use GitHub Actions to build and deploy your pages by just pushing your repository to GitHub! You don't even need to do anything except to add a configuration file to your repository. In this post, I will be creating a workflow and using peaceiris/actions-gh-pages@v3 from GitHub Marketplace (it's free).
What are some alternatives?
conventional-commit - commit binary powered by commitizen with conventional commit standard
github-pages-deploy-action - 🚀 Automatically deploy your project to GitHub Pages using GitHub Actions. This action can be configured to push your production-ready code into any branch you'd like.
open-sauced - 🍕 This is a project to identify your next open source contribution.
trailing-slash-guide - Understand and fix your static website trailing slash issues!
first-interaction - An action for filtering pull requests and issues from first-time contributors
tauri-action - Build your Web application as a Tauri binary for macOS, Linux and Windows
pr-compliance-action - Check PR for compliance on title, linked issues, and files changed
actions-mdbook - GitHub Actions for mdBook (rust-lang/mdBook) ⚡️ Setup mdBook quickly and build your site fast. Linux (Ubuntu), macOS, and Windows are supported.
docs.opensauced.pizzaLICENSE
actions-hugo - GitHub Actions for Hugo ⚡️ Setup Hugo quickly and build your site fast. Hugo extended, Hugo Modules, Linux (Ubuntu), macOS, and Windows are supported.
mdbook-admonish - A preprocessor for mdbook to add Material Design admonishments.
setup-node - Set up your GitHub Actions workflow with a specific version of node.js