From d2b1d4bcfae02306eb22b69f5be28f406ffa622f Mon Sep 17 00:00:00 2001 From: simon Date: Mon, 2 Dec 2024 11:20:24 +0000 Subject: [PATCH] =?UTF-8?q?=E2=9C=85=20Ready=20to=20clone=20and=20code.?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../conventional_commits/generate-version.sh | 4 +- .gitea/rename_project.sh | 42 ---------------- .gitea/template.yml | 1 - .gitea/workflows/release.yml | 2 +- .gitea/workflows/rename_project.yml | 48 ------------------- .gitea/workflows/sonar.yml | 4 +- CONTRIBUTING.md | 8 ++-- Containerfile | 4 +- .../LevelInputProvider.Tests.csproj | 2 +- .../UnitTest1.cs | 4 +- project_name.sln => LevelInputProvider.sln | 4 +- .../HelloWorldProvider.cs | 2 +- .../LevelInputProvider.csproj | 0 {project_name => LevelInputProvider}/VERSION | 0 MANIFEST.in | 2 +- Makefile | 14 +++--- README.md | 2 +- mkdocs.yml | 2 +- 18 files changed, 27 insertions(+), 118 deletions(-) delete mode 100755 .gitea/rename_project.sh delete mode 100644 .gitea/template.yml delete mode 100644 .gitea/workflows/rename_project.yml rename project_name.Tests/project_name.Tests.csproj => LevelInputProvider.Tests/LevelInputProvider.Tests.csproj (86%) rename {project_name.Tests => LevelInputProvider.Tests}/UnitTest1.cs (75%) rename project_name.sln => LevelInputProvider.sln (80%) rename {project_name => LevelInputProvider}/HelloWorldProvider.cs (89%) rename project_name/project_name.csproj => LevelInputProvider/LevelInputProvider.csproj (100%) rename {project_name => LevelInputProvider}/VERSION (100%) diff --git a/.gitea/conventional_commits/generate-version.sh b/.gitea/conventional_commits/generate-version.sh index 828c9d7..2f00478 100755 --- a/.gitea/conventional_commits/generate-version.sh +++ b/.gitea/conventional_commits/generate-version.sh @@ -86,8 +86,8 @@ start() { echo "New version: $new_version" gitchangelog | grep -v "[rR]elease:" > HISTORY.md - echo $new_version > project_name/VERSION - git add project_name/VERSION + echo $new_version > LevelInputProvider/VERSION + git add LevelInputProvider/VERSION git add HISTORY.md git commit -m "release: version $new_version 🚀" echo "creating git tag : $new_version" diff --git a/.gitea/rename_project.sh b/.gitea/rename_project.sh deleted file mode 100755 index 66cb172..0000000 --- a/.gitea/rename_project.sh +++ /dev/null @@ -1,42 +0,0 @@ -#!/usr/bin/env bash -while getopts a:n:u:d: flag -do - case "${flag}" in - a) author=${OPTARG};; - n) name=${OPTARG};; - u) urlname=${OPTARG};; - d) description=${OPTARG};; - esac -done - -echo "Author: $author"; -echo "Project Name: $name"; -echo "Project URL name: $urlname"; -echo "Description: $description"; - -echo "Renaming project..." - -original_author="author_name" -original_name="project_name" -original_urlname="project_urlname" -original_description="project_description" -# for filename in $(find . -name "*.*") -for filename in $(git ls-files) -do - sed -i "s/$original_author/$author/g" $filename - sed -i "s/$original_name/$name/g" $filename - sed -i "s/$original_urlname/$urlname/g" $filename - sed -i "s/$original_description/$description/g" $filename - echo "Renamed $filename" -done - -mv project_name $name -mv project_name.Tests $name.Tests -mv project_name.sln $name.sln -mv $name/project_name.csproj $name/$name.csproj -mv $name.Tests/project_name.Tests.csproj $name.Tests/$name.Tests.csproj - -# This command runs only once on GHA! -rm -rf .gitea/template.yml -rm -rf project_name -rm -rf project_name.Tests diff --git a/.gitea/template.yml b/.gitea/template.yml deleted file mode 100644 index 3386bee..0000000 --- a/.gitea/template.yml +++ /dev/null @@ -1 +0,0 @@ -author: rochacbruno diff --git a/.gitea/workflows/release.yml b/.gitea/workflows/release.yml index 6dd2765..dfcc95a 100644 --- a/.gitea/workflows/release.yml +++ b/.gitea/workflows/release.yml @@ -64,5 +64,5 @@ jobs: QUOTED_REPOSITORY_SOURCE_NAME=$(dotnet nuget config get all | grep "/packages/${REPOSITORY_OWNER}/nuget/index.json" | awk '{print $2}' | awk -F= '{print $2}') REPOSITORY_SOURCE_NAME=${QUOTED_REPOSITORY_SOURCE_NAME:1:-1} fi - dotnet pack --include-symbols --include-source -p:PackageVersion=$(cat $REPOSITORY_NAME/VERSION) project_name.sln + dotnet pack --include-symbols --include-source -p:PackageVersion=$(cat $REPOSITORY_NAME/VERSION) LevelInputProvider.sln dotnet nuget push -k $GITEA_PAT --source $REPOSITORY_SOURCE_NAME $REPOSITORY_NAME/bin/Release/$REPOSITORY_NAME.$(cat $REPOSITORY_NAME/VERSION).symbols.nupkg diff --git a/.gitea/workflows/rename_project.yml b/.gitea/workflows/rename_project.yml deleted file mode 100644 index f43225e..0000000 --- a/.gitea/workflows/rename_project.yml +++ /dev/null @@ -1,48 +0,0 @@ -name: Rename the project from template - -on: [push] - -permissions: write-all - -jobs: - rename-project: - if: ${{ !endsWith (gitea.repository, 'Templates/Dotnet_Library') }} - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v3 - with: - # by default, it uses a depth of 1 - # this fetches all history so that we can read each commit - fetch-depth: 0 - ref: ${{ gitea.head_ref }} - - - run: echo "REPOSITORY_NAME=$(echo "$GITHUB_REPOSITORY" | awk -F '/' '{print $2}' | tr '-' '_')" >> $GITHUB_ENV - shell: bash - - - run: echo "REPOSITORY_URLNAME=$(echo "$GITHUB_REPOSITORY" | awk -F '/' '{print $2}')" >> $GITHUB_ENV - shell: bash - - - run: echo "REPOSITORY_OWNER=$(echo "$GITHUB_REPOSITORY" | awk -F '/' '{print $1}')" >> $GITHUB_ENV - shell: bash - - - name: Is this still a template - id: is_template - run: echo "::set-output name=is_template::$(ls .gitea/template.yml &> /dev/null && echo true || echo false)" - - - name: Rename the project - if: steps.is_template.outputs.is_template == 'true' - run: | - echo "Renaming the project with -a(author) ${{ env.REPOSITORY_OWNER }} -n(name) ${{ env.REPOSITORY_NAME }} -u(urlname) ${{ env.REPOSITORY_URLNAME }}" - .gitea/rename_project.sh -a ${{ env.REPOSITORY_OWNER }} -n ${{ env.REPOSITORY_NAME }} -u ${{ env.REPOSITORY_URLNAME }} -d "Awesome ${{ env.REPOSITORY_NAME }} created by ${{ env.REPOSITORY_OWNER }}" - - - name: Remove renaming workflow - if: steps.is_template.outputs.is_template == 'true' - run: | - rm .gitea/workflows/rename_project.yml - rm .gitea/rename_project.sh - - - uses: stefanzweifel/git-auto-commit-action@v4 - with: - commit_message: "✅ Ready to clone and code." - # commit_options: '--amend --no-edit' - push_options: --force diff --git a/.gitea/workflows/sonar.yml b/.gitea/workflows/sonar.yml index 7f62db9..4db57d2 100644 --- a/.gitea/workflows/sonar.yml +++ b/.gitea/workflows/sonar.yml @@ -10,7 +10,7 @@ jobs: sonarqube: name: SonarQube Trigger runs-on: ubuntu-latest - if: ${{ !contains ('project_name', format('{0}_{1}', 'project', 'name')) }} + if: ${{ !contains ('LevelInputProvider', format('{0}_{1}', 'project', 'name')) }} steps: - name: Checking out uses: actions/checkout@v4 @@ -24,4 +24,4 @@ jobs: SONAR_HOST_URL: ${{ secrets.SONARQUBE_HOST }} with: args: > - -Dsonar.projectKey=project_name \ No newline at end of file + -Dsonar.projectKey=LevelInputProvider \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aff917f..b3eb2d5 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # How to develop on this project -project_name welcomes contributions from the community. +LevelInputProvider welcomes contributions from the community. **You need Dotnet 9!** @@ -8,9 +8,9 @@ This instructions are for linux base systems. (Linux, MacOS, BSD, etc.) ## Setting up your own fork of this repo. - On gitea interface click on `Fork` button. -- Clone your fork of this repo. `git clone git@git.disi.dev:YOUR_GIT_USERNAME/project_urlname.git` -- Enter the directory `cd project_urlname` -- Add upstream repo `git remote add upstream https://git.disi.dev/author_name/project_urlname` +- Clone your fork of this repo. `git clone git@git.disi.dev:YOUR_GIT_USERNAME/LevelInputProvider.git` +- Enter the directory `cd LevelInputProvider` +- Add upstream repo `git remote add upstream https://git.disi.dev/simon/LevelInputProvider` ## Run the tests to ensure everything is working diff --git a/Containerfile b/Containerfile index 21c0a2b..1d721b7 100644 --- a/Containerfile +++ b/Containerfile @@ -1,4 +1,4 @@ FROM mcr.microsoft.com/dotnet/runtime:9.0 -COPY ./project_name/bin/Release/net9.0/ /app +COPY ./LevelInputProvider/bin/Release/net9.0/ /app WORKDIR /app -CMD ["project_name"] +CMD ["LevelInputProvider"] diff --git a/project_name.Tests/project_name.Tests.csproj b/LevelInputProvider.Tests/LevelInputProvider.Tests.csproj similarity index 86% rename from project_name.Tests/project_name.Tests.csproj rename to LevelInputProvider.Tests/LevelInputProvider.Tests.csproj index 184e6f4..9953db0 100644 --- a/project_name.Tests/project_name.Tests.csproj +++ b/LevelInputProvider.Tests/LevelInputProvider.Tests.csproj @@ -9,7 +9,7 @@ - + diff --git a/project_name.Tests/UnitTest1.cs b/LevelInputProvider.Tests/UnitTest1.cs similarity index 75% rename from project_name.Tests/UnitTest1.cs rename to LevelInputProvider.Tests/UnitTest1.cs index 2e6a555..9577bbd 100644 --- a/project_name.Tests/UnitTest1.cs +++ b/LevelInputProvider.Tests/UnitTest1.cs @@ -1,6 +1,6 @@ -namespace project_name.Tests; +namespace LevelInputProvider.Tests; -using project_name; +using LevelInputProvider; public class UnitTest1 { diff --git a/project_name.sln b/LevelInputProvider.sln similarity index 80% rename from project_name.sln rename to LevelInputProvider.sln index 5098aa7..ca3886c 100644 --- a/project_name.sln +++ b/LevelInputProvider.sln @@ -3,9 +3,9 @@ Microsoft Visual Studio Solution File, Format Version 12.00 # Visual Studio Version 17 VisualStudioVersion = 17.0.31903.59 MinimumVisualStudioVersion = 10.0.40219.1 -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "project_name", "project_name\project_name.csproj", "{5AF6E15A-7BFC-49EB-AC97-A2AA1B131608}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "LevelInputProvider", "LevelInputProvider\LevelInputProvider.csproj", "{5AF6E15A-7BFC-49EB-AC97-A2AA1B131608}" EndProject -Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "project_name.Tests", "project_name.Tests\project_name.Tests.csproj", "{FD1B8A2E-3BA7-4FDD-96FB-18551A15A5F3}" +Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "LevelInputProvider.Tests", "LevelInputProvider.Tests\LevelInputProvider.Tests.csproj", "{FD1B8A2E-3BA7-4FDD-96FB-18551A15A5F3}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/project_name/HelloWorldProvider.cs b/LevelInputProvider/HelloWorldProvider.cs similarity index 89% rename from project_name/HelloWorldProvider.cs rename to LevelInputProvider/HelloWorldProvider.cs index 141d83a..974fb18 100644 --- a/project_name/HelloWorldProvider.cs +++ b/LevelInputProvider/HelloWorldProvider.cs @@ -1,4 +1,4 @@ -namespace project_name; +namespace LevelInputProvider; public class HelloWorldProvider { diff --git a/project_name/project_name.csproj b/LevelInputProvider/LevelInputProvider.csproj similarity index 100% rename from project_name/project_name.csproj rename to LevelInputProvider/LevelInputProvider.csproj diff --git a/project_name/VERSION b/LevelInputProvider/VERSION similarity index 100% rename from project_name/VERSION rename to LevelInputProvider/VERSION diff --git a/MANIFEST.in b/MANIFEST.in index ef198d6..39dd8a7 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -2,4 +2,4 @@ include LICENSE include HISTORY.md include Containerfile graft tests -graft project_name +graft LevelInputProvider diff --git a/Makefile b/Makefile index 29686cc..cc18a79 100644 --- a/Makefile +++ b/Makefile @@ -17,31 +17,31 @@ help: ## Show the help. .PHONY: buildrel buildrel: issetup ## Format code. - dotnet build -c Release project_name.sln + dotnet build -c Release LevelInputProvider.sln .PHONY: build build: issetup ## Format code. - dotnet build project_name.sln + dotnet build LevelInputProvider.sln .PHONY: publish publish: issetup ## Format code. - dotnet publish -c Release project_name.sln + dotnet publish -c Release LevelInputProvider.sln .PHONY: fmt fmt: issetup ## Format code. - dotnet format project_name.sln + dotnet format LevelInputProvider.sln .PHONY: lint lint: issetup ## Lint code. - dotnet format --verify-no-changes --verbosity diagnostic project_name.sln + dotnet format --verify-no-changes --verbosity diagnostic LevelInputProvider.sln .PHONY: test test: issetup ## Run tests and generate coverage report. - dotnet test project_name.sln + dotnet test LevelInputProvider.sln .PHONY: clean clean: issetup ## Clean unused files. - dotnet clean project_name.sln + dotnet clean LevelInputProvider.sln .PHONY: release release: issetup ## Create a new tag for release. diff --git a/README.md b/README.md index e3a219a..555b642 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# project_name +# LevelInputProvider This project provides inputs for Advent of Code puzzles. Be careful: these inputs are tailored to a specific user account and might not be valid for your examples! diff --git a/mkdocs.yml b/mkdocs.yml index 33a69ca..d4ae844 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,2 +1,2 @@ -site_name: project_name +site_name: LevelInputProvider theme: readthedocs