From b105fc9edd826f16e32202f960565644fca9cd5e Mon Sep 17 00:00:00 2001 From: Xavi Ablaza Date: Mon, 12 Feb 2024 14:50:08 -0600 Subject: [PATCH 1/4] Update copyright years and attribution --- LICENSE | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/LICENSE b/LICENSE index 326efa4..29b12f5 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2022 Pauline De Polonia +Copyright (c) 2022-2024 Hostari Philippines, Inc. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal From 07ec5d91257a4f9038090bfdf6a54b999fd722dd Mon Sep 17 00:00:00 2001 From: Xavi Ablaza Date: Mon, 12 Feb 2024 14:50:26 -0600 Subject: [PATCH 2/4] Update shard description and add Xavi Ablaza as maintainer --- README.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/README.md b/README.md index 117a9fc..9b4bc55 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # thunderstore_downloader -A crystal wrapper to download and unzip thunderstore package versions and walk through each files within the folder to get their SHA256 hashes. +Downloads and unzips thunderstore package versions and walks through each file within the folder to get its SHA256 hash. ## Installation @@ -20,12 +20,6 @@ A crystal wrapper to download and unzip thunderstore package versions and walk t require "thunderstore_downloader" ``` -TODO: Write usage instructions here - -## Development - -TODO: Write development instructions here - ## Contributing 1. Fork it () @@ -36,4 +30,5 @@ TODO: Write development instructions here ## Contributors -- [Pauline De Polonia](https://github.com/your-github-user) - creator and maintainer +- [Pauline De Polonia](https://github.com/paula4230) - creator +- [Xavi Ablaza](https://github.com/xaviablaza) - maintainer From 43c656bd077399866748757502950e86d47b0a1c Mon Sep 17 00:00:00 2001 From: Xavi Ablaza Date: Mon, 12 Feb 2024 14:51:10 -0600 Subject: [PATCH 3/4] Add github workflows --- .github/workflows/ci.yml | 20 +++++++++++++++ .github/workflows/docs.yml | 51 ++++++++++++++++++++++++++++++++++++++ 2 files changed, 71 insertions(+) create mode 100644 .github/workflows/ci.yml create mode 100644 .github/workflows/docs.yml diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..908be79 --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,20 @@ +name: Crystal CI +on: + pull_request: + branches: [ "main" ] +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/setup-node@v4 + with: + node-version: 20.x + - uses: crystal-lang/install-crystal@v1 + with: + crystal: 1.6.2 + - name: Download source + uses: actions/checkout@v4 + - name: Install dependencies + run: shards install + - name: Run tests + run: crystal spec diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml new file mode 100644 index 0000000..3eab2f0 --- /dev/null +++ b/.github/workflows/docs.yml @@ -0,0 +1,51 @@ +name: Crystal Docs Generation + +on: + push: + branches: [ "main" ] + # Allows you to run this workflow manually from the Actions tab + workflow_dispatch: + +# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages +permissions: + contents: read + pages: write + id-token: write + +# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued. +# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete. +concurrency: + group: "pages" + cancel-in-progress: false + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - uses: actions/setup-node@v4 + with: + node-version: 20.x + - uses: crystal-lang/install-crystal@v1 + with: + crystal: 1.6.2 + - uses: actions/checkout@v4 + - name: Generate docs + run: crystal docs + - name: Move docs to _site + run: mv docs/ _site/ + - name: Upload artifact + uses: actions/upload-pages-artifact@v3 + + # Deployment job + deploy: + environment: + name: github-pages + url: ${{ steps.deployment.outputs.page_url }} + runs-on: ubuntu-latest + needs: build + steps: + - name: Deploy to GitHub Pages + id: deployment + uses: actions/deploy-pages@v4 From 1825783af239ca7537d2a9e186b5b781d3706649 Mon Sep 17 00:00:00 2001 From: Xavi Ablaza Date: Mon, 12 Feb 2024 14:51:01 -0600 Subject: [PATCH 4/4] Bump version to 1.0.0 --- shard.yml | 5 +++-- src/thunderstore_downloader.cr | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/shard.yml b/shard.yml index f9f30ea..a0e8e8a 100644 --- a/shard.yml +++ b/shard.yml @@ -1,9 +1,10 @@ name: thunderstore_downloader -version: 0.1.0 +version: 1.0.0 authors: - Pauline De Polonia + - Xavi Ablaza <25378966+xaviablaza@users.noreply.github.com> -crystal: 1.4.1 +crystal: ~> 1.6.2 license: MIT diff --git a/src/thunderstore_downloader.cr b/src/thunderstore_downloader.cr index 3444812..5525718 100644 --- a/src/thunderstore_downloader.cr +++ b/src/thunderstore_downloader.cr @@ -2,7 +2,7 @@ require "json" require "http/client" module ThunderstorePackageDownloader - VERSION = "0.1.0" + VERSION = "1.0.0" end require "./thunderstore_downloader/**"