Chips-n-Salsa
awesome-readme
Our great sponsors
Chips-n-Salsa | awesome-readme | |
---|---|---|
15 | 30 | |
52 | 16,961 | |
- | - | |
8.4 | 6.9 | |
5 days ago | 1 day ago | |
Java | ||
GNU General Public License v3.0 only | - |
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.
Chips-n-Salsa
-
Deploy a Documentation Website for a Java Library Using GitHub Actions
name: docs on: push: branches: [ master ] paths: [ '**.java', '.github/workflows/docs.yml' ] pull_request: branches: [ master ] release: types: [created] workflow_dispatch: jobs: docs: runs-on: ubuntu-latest steps: - name: Checkout the repo uses: actions/checkout@v3 - name: Checkout the gh-pages branch uses: actions/checkout@v3 with: fetch-depth: 0 ref: gh-pages path: gh-pages - name: Set up JDK 17 uses: actions/setup-java@v3 with: distribution: 'adopt' java-version: '17' - name: Build docs with Maven run: mvn compile javadoc:javadoc - name: Copy to Documentation Website Location if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} run: | rm -rf gh-pages/api cp -rf target/site/apidocs/. gh-pages/api - name: Tidy up the javadocs if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} id: tidy uses: cicirello/javadoc-cleanup@v1 with: base-url-path: https://chips-n-salsa.cicirello.org/ path-to-root: gh-pages user-defined-block: | - name: Log javadoc-cleanup output if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} run: | echo "modified-count = ${{ steps.tidy.outputs.modified-count }}" - name: Commit documentation changes without pushing yet if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} run: | cd gh-pages if [[ `git status --porcelain` ]]; then git config --global user.name 'github-actions' git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com' git add -A git commit -m "Automated API website updates." fi cd .. - name: Generate the sitemap if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} id: sitemap uses: cicirello/generate-sitemap@v1 with: base-url-path: https://chips-n-salsa.cicirello.org/ path-to-root: gh-pages - name: Output stats if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} run: | echo "sitemap-path = ${{ steps.sitemap.outputs.sitemap-path }}" echo "url-count = ${{ steps.sitemap.outputs.url-count }}" echo "excluded-count = ${{ steps.sitemap.outputs.excluded-count }}" - name: Commit documentation website sitemap and push all commits if: ${{ github.event_name == 'release' || github.event_name == 'workflow_dispatch' }} run: | cd gh-pages if [[ `git status --porcelain` ]]; then git config --global user.name 'github-actions' git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com' git add -A git commit -m "Automated API website sitemap update." fi git push cd ..
-
Deploying Java Artifacts to Multiple Maven Repositories with GitHub Actions
Website: https://chips-n-salsa.cicirello.org/
-
How to Patch the Deprecated set-output in GitHub Workflows and in Container Actions
The complete workflow file that this example is derived from is maven-publish.yml.
-
How to Use Maven Profiles to Selectively Activate Plugins and Other Configuration from the Command Line
Let's look at a real example, again from Chips-n-Salsa, where I publish artifacts of the library on both Maven Central as well as to GitHub Packages. We'll build up to the full example. First, consider the configuration below:
-
How to Use the Maven Shade Plugin if Your Project Uses Java Platform Module System
To see a live example, you can consult the pom.xml of one of my projects. Here is the GitHub repository:
-
Configuring GitHub's Linguist to Improve Repository Language Reporting
GitHub Language Chart From https://github.com/cicirello/Chips-n-Salsa
-
Ahead-of-time JitPack Builds with Custom GroupId via GitHub Actions
Website: https://chips-n-salsa.cicirello.org/
-
How to Configure JitPack for Recent JDK Versions
Important Note: Because of the way JitPack essentially builds a snapshot of your repository, even for release builds, the jitpack.yml must be present within the specific snapshot of your repository in order to apply. For example, for the library that this post is based upon, Chips-n-Salsa, the first release where the repository contains the configuration file is 5.0.1, so JitPack will fail to build any prior version, although earlier versions are available via Maven Central and GitHub Packages. Likewise, if you specify any commit hash prior to that of the commit where that configuration file was introduced, the JitPack build will also fail.
-
How to Enable DEV Post Embeds for Pages From Your Website
Chips-n-Salsa - A Java library of customizable, hybridizable, iterative, parallel, stochastic, and self-adaptive local search algorithms
- Badges - TL;DR for your repository's README
awesome-readme
- Readme: A Curated List of READMEs
- Awesome Readme: A Curated List of READMEs
-
Hacktoberfest 2023 Update from Maintainer of the user-statistician GitHub Action
About user-statistician
-
Hacktoberfest 2023 Contributors Wanted: Additional Translations for the user-statistician GitHub Action
The user-statistician GitHub Action can generate an SVG with a detailed summary of your activity on GitHub. It is mentioned in the tools section of the awesome README awesome list. The SVG it generates includes general information about you (e.g., year you joined, number of followers, number you are following, most starred repository, etc), information about your repositories (e.g., numbers of stars and forks, etc), information about your contributions (e.g., numbers of commits, issues, PRs, etc), and the distribution of languages within your public repositories.
- Mastering Readme Files
-
Marketing for Developers
If you really want a stellar README.md take a look at some of the examples in awesome-readme for inspiration!
-
How to Create the Best README for Your GitHub Project
Awesome README - A collection of high-quality READMEs from a variety of projects, organized by topic. https://github.com/matiassingers/awesome-readme
-
How to create projects for myself to enrich my resume?
Provide a succinct and comprehensive README: readers of your personal project will always start with the README to know where to begin. The goal of the README is to provide the reader an understanding of the business problem you are trying to solve, how your solution goes about solving it (solution architecture diagram), and how to get started and run your code. There are plenty of great README examples here: https://github.com/matiassingers/awesome-readme
-
Configuring GitHub's Linguist to Improve Repository Language Reporting
About user-statistician
-
The user-statistician GitHub Action mentioned in Awesome-README
Recently, the user-statistician GitHub Action was added to the tools section of Awesome README, which is an Awesome List that includes a curated collection of examples of Awesome READMEs from open source projects, as well as tools enabling creating Awesome READMEs. The Awesome README list is a great place to go if you are looking for ideas for how to improve the READMEs of your open source projects. The Awesome README list covers READMEs more generally, but the tools section includes a few tools focused on Profile READMEs, in addition to many tools for project READMEs more generally. The user-statistician GitHub Action is in the Tools Section.
What are some alternatives?
jacoco-badge-generator - Coverage badges, and pull request coverage checks, from JaCoCo reports in GitHub Actions
revo-grid - Powerful virtual data grid smartsheet with advanced customization. Best features from excel plus incredible performance 🔋
generate-sitemap - Generate an XML sitemap for a GitHub Pages site using GitHub Actions
Konva - Konva.js is an HTML5 Canvas JavaScript framework that extends the 2d context by enabling canvas interactivity for desktop and mobile applications.
user-statistician - Generate a GitHub stats SVG for your GitHub Profile README in GitHub Actions
Apache AGE - Graph database optimized for fast analysis and real-time data processing. It is provided as an extension to PostgreSQL. [Moved to: https://github.com/apache/age]
setup-java - Set up your GitHub Actions workflow with a specific version of Java
amplify-cli - The AWS Amplify CLI is a toolchain for simplifying serverless web and mobile development.
upload-artifact
spring-rest-crud-example - Use this repository as a basis to start the development of a new Java REST API.
maven-simple - Example Maven project demonstrating the use of
minio-py - MinIO Client SDK for Python