diff --git a/.gitea/rename_project.sh b/.gitea/rename_project.sh deleted file mode 100755 index 022fc64..0000000 --- a/.gitea/rename_project.sh +++ /dev/null @@ -1,40 +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 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/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..29d1af6 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 ('TextParser', 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=TextParser \ No newline at end of file diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index aff917f..dfb0c63 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # How to develop on this project -project_name welcomes contributions from the community. +TextParser 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/TextParser.git` +- Enter the directory `cd TextParser` +- Add upstream repo `git remote add upstream https://git.disi.dev/Projects/TextParser` ## Run the tests to ensure everything is working diff --git a/Containerfile b/Containerfile index 21c0a2b..d2b7bb8 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 ./TextParser/bin/Release/net9.0/ /app WORKDIR /app -CMD ["project_name"] +CMD ["TextParser"] diff --git a/MANIFEST.in b/MANIFEST.in index ef198d6..7e40cb6 100644 --- a/MANIFEST.in +++ b/MANIFEST.in @@ -2,4 +2,4 @@ include LICENSE include HISTORY.md include Containerfile graft tests -graft project_name +graft TextParser diff --git a/Makefile b/Makefile index ceb6b7c..cca439a 100644 --- a/Makefile +++ b/Makefile @@ -17,41 +17,41 @@ help: ## Show the help. .PHONY: buildrel buildrel: issetup ## Format code. - dotnet build -c Release project_name.sln + dotnet build -c Release TextParser.sln .PHONY: build build: issetup ## Format code. - dotnet build project_name.sln + dotnet build TextParser.sln .PHONY: publish publish: issetup ## Format code. - dotnet publish -c Release project_name.sln + dotnet publish -c Release TextParser.sln .PHONY: fmt fmt: issetup ## Format code. - dotnet format project_name.sln + dotnet format TextParser.sln .PHONY: lint lint: issetup ## Lint code. - dotnet format --verify-no-changes --verbosity diagnostic project_name.sln + dotnet format --verify-no-changes --verbosity diagnostic TextParser.sln .PHONY: test test: issetup ## Run tests and generate coverage report. - dotnet test project_name.sln + dotnet test TextParser.sln .PHONY: clean clean: issetup ## Clean unused files. - dotnet clean project_name.sln + dotnet clean TextParser.sln .PHONY: release release: issetup ## Create a new tag for release. @echo "WARNING: This operation will create a version tag and push to gitea" - @read -p "Version? (provide the next x.y.z semver) : " TAG; echo "$$TAG" > project_name/VERSION + @read -p "Version? (provide the next x.y.z semver) : " TAG; echo "$$TAG" > TextParser/VERSION @gitchangelog > HISTORY.md - @git add project_name/VERSION HISTORY.md - @git commit -m "release: version $$(cat project_name/VERSION) 🚀" - @echo "creating git tag : $$(cat project_name/VERSION)" - @git tag $$(cat project_name/VERSION) + @git add TextParser/VERSION HISTORY.md + @git commit -m "release: version $$(cat TextParser/VERSION) 🚀" + @echo "creating git tag : $$(cat TextParser/VERSION)" + @git tag $$(cat TextParser/VERSION) @git push -u origin HEAD --tags @echo "Gitea Actions will detect the new tag and release the new version." diff --git a/README.md b/README.md index 7254b73..030c446 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# project_name +# TextParser A generic inpout parser class. Capable of tokenizing any text input according to preset rules. Mainly used and created for solving Advent of Code challenges in 2024. diff --git a/project_name.Tests/project_name.Tests.csproj b/TextParser.Tests/TextParser.Tests.csproj similarity index 87% rename from project_name.Tests/project_name.Tests.csproj rename to TextParser.Tests/TextParser.Tests.csproj index 184e6f4..224a50d 100644 --- a/project_name.Tests/project_name.Tests.csproj +++ b/TextParser.Tests/TextParser.Tests.csproj @@ -9,7 +9,7 @@ - + diff --git a/project_name.Tests/UnitTest1.cs b/TextParser.Tests/UnitTest1.cs similarity index 78% rename from project_name.Tests/UnitTest1.cs rename to TextParser.Tests/UnitTest1.cs index 2e6a555..643b108 100644 --- a/project_name.Tests/UnitTest1.cs +++ b/TextParser.Tests/UnitTest1.cs @@ -1,6 +1,6 @@ -namespace project_name.Tests; +namespace TextParser.Tests; -using project_name; +using TextParser; public class UnitTest1 { diff --git a/project_name.sln b/TextParser.sln similarity index 81% rename from project_name.sln rename to TextParser.sln index 5098aa7..3fd03fd 100644 --- a/project_name.sln +++ b/TextParser.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}") = "TextParser", "TextParser\TextParser.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}") = "TextParser.Tests", "TextParser.Tests\TextParser.Tests.csproj", "{FD1B8A2E-3BA7-4FDD-96FB-18551A15A5F3}" EndProject Global GlobalSection(SolutionConfigurationPlatforms) = preSolution diff --git a/project_name/HelloWorldProvider.cs b/TextParser/HelloWorldProvider.cs similarity index 90% rename from project_name/HelloWorldProvider.cs rename to TextParser/HelloWorldProvider.cs index 141d83a..a728aef 100644 --- a/project_name/HelloWorldProvider.cs +++ b/TextParser/HelloWorldProvider.cs @@ -1,4 +1,4 @@ -namespace project_name; +namespace TextParser; public class HelloWorldProvider { diff --git a/project_name/project_name.csproj b/TextParser/TextParser.csproj similarity index 100% rename from project_name/project_name.csproj rename to TextParser/TextParser.csproj diff --git a/project_name/VERSION b/TextParser/VERSION similarity index 100% rename from project_name/VERSION rename to TextParser/VERSION diff --git a/mkdocs.yml b/mkdocs.yml index 33a69ca..da4d8d6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,2 +1,2 @@ -site_name: project_name +site_name: TextParser theme: readthedocs