removed emojies from readme
This commit is contained in:
104
.github/workflows/test.yml
vendored
104
.github/workflows/test.yml
vendored
@@ -1,104 +0,0 @@
|
||||
name: Build NuGet
|
||||
|
||||
on:
|
||||
push:
|
||||
branches: [ main ]
|
||||
|
||||
jobs:
|
||||
build:
|
||||
|
||||
runs-on: ubuntu-latest
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
with:
|
||||
fetch-depth: 0
|
||||
|
||||
- name: Setup .NET
|
||||
uses: actions/setup-dotnet@v4
|
||||
with:
|
||||
dotnet-version: 10.0.x
|
||||
|
||||
- name: Restore
|
||||
run: dotnet restore
|
||||
- name: Calculate Version
|
||||
id: version
|
||||
run: |
|
||||
TAG=$(git describe --tags --abbrev=0)
|
||||
COMMITS=$(git rev-list $TAG..HEAD --count)
|
||||
|
||||
BASE=${TAG#v}
|
||||
|
||||
IFS='.' read MAJOR MINOR PATCH <<< "$BASE"
|
||||
|
||||
NEW_PATCH=$((PATCH + COMMITS))
|
||||
|
||||
VERSION="$MAJOR.$MINOR.$NEW_PATCH"
|
||||
|
||||
echo "VERSION=$VERSION" >> $GITHUB_OUTPUT
|
||||
- name: Build
|
||||
run: dotnet build -c Release
|
||||
|
||||
- name: Pack
|
||||
run: |
|
||||
dotnet pack \
|
||||
-p:PackageVersion=${{ steps.version.outputs.VERSION }} \
|
||||
-c Release
|
||||
|
||||
- name: Publish
|
||||
run: |
|
||||
dotnet nuget push GodotHelper/nupkg/*.nupkg \
|
||||
--source "http://192.168.1.4:3000/api/packages/Ronnie/nuget/index.json" \
|
||||
--allow-insecure-connections \
|
||||
--api-key "${{ secrets.NUGET_KEY }}" \
|
||||
--skip-duplicate
|
||||
|
||||
# name: Gitea Actions Demo
|
||||
# run-name: ${{ gitea.actor }} is testing out Gitea Actions
|
||||
# on: [push]
|
||||
|
||||
# jobs:
|
||||
# Explore-Gitea-Actions:
|
||||
# runs-on: ubuntu-latest
|
||||
# steps:
|
||||
# - run: echo " The job was automatically triggered by a ${{ gitea.event_name }} event."
|
||||
# - run: echo " This job is now running on a ${{ runner.os }} server hosted by Gitea!"
|
||||
# - run: echo " The name of your branch is ${{ gitea.ref }} and your repository is ${{ gitea.repository }}."
|
||||
# - name: Checkout
|
||||
# uses: actions/checkout@v3
|
||||
# # with:
|
||||
# # repository: Ronnie/SjkScripts
|
||||
# # token: ${{ gitea.token }}
|
||||
# # github-server-url: http://192.168.1.4:3000
|
||||
# - run: echo " The ${{ gitea.repository }} repository has been cloned to the runner."
|
||||
# - run: echo " The workflow is now ready to test your code on the runner."
|
||||
# - name: List files in the repository
|
||||
# run: |
|
||||
# ls ${{ gitea.workspace }}
|
||||
# - run: echo " This job's status is ${{ job.status }}."
|
||||
# - run: echo " HELP ME, I'M A GITHUB ACTION."
|
||||
# - run: echo " HELP ME PLEASE."
|
||||
# - run: echo " I'M SO TIRED."
|
||||
# - run: echo " 9999999."
|
||||
# name: Gitea Actions Demo
|
||||
# run-name: ${{ gitea.actor }} is testing out Gitea Actions
|
||||
# on: [push]
|
||||
|
||||
# jobs:
|
||||
# Explore-Gitea-Actions:
|
||||
# runs-on: ubuntu-latest
|
||||
# steps:
|
||||
# - run: echo " The job was automatically triggered by a ${{ gitea.event_name }} event."
|
||||
# - run: echo " This job is now running on a ${{ runner.os }} server hosted by Gitea!"
|
||||
# - run: echo " The name of your branch is ${{ gitea.ref }} and your repository is ${{ gitea.repository }}."
|
||||
# - name: Check out repository code
|
||||
# run: |
|
||||
# git clone http://192.168.1.4:3000/Ronnie/SjkScripts.git
|
||||
# - run: echo " The ${{ gitea.repository }} repository has been cloned to the runner."
|
||||
# - run: echo " The workflow is now ready to test your code on the runner."
|
||||
# - name: List files in the repository
|
||||
# run: |
|
||||
# ls ${{ gitea.workspace }}
|
||||
# - run: echo " This job's status is ${{ job.status }}."
|
||||
# - run: echo " HELP ME, I'M A GITHUB ACTION."
|
||||
#e59e39d60f30b539ae594d8cfc7a9771883d2eb0
|
||||
24
README.md
24
README.md
@@ -10,7 +10,7 @@ A .NET template for quickly creating a C# nuget package for use with Godot 4.
|
||||
<img alt="GodotHelper" src="GodotHelper/icon.png" width="200">
|
||||
</p>
|
||||
|
||||
## 🥚 Getting Started
|
||||
## Getting Started
|
||||
|
||||
This template allows you to easily create a nuget package for use in Godot 4 C# projects. Microsoft's `dotnet` tool allows you to easily create, install, and use templates.
|
||||
|
||||
@@ -27,11 +27,11 @@ $GODOT --headless --build-solutions --quit
|
||||
dotnet build
|
||||
```
|
||||
|
||||
## 💁 Getting Help
|
||||
## Getting Help
|
||||
|
||||
*Is this template broken? Encountering obscure C# build problems?* We'll be happy to help you in the [Chickensoft Discord server][discord].
|
||||
|
||||
## 🏝 Environment Setup
|
||||
## Environment Setup
|
||||
|
||||
For the provided debug configurations and test coverage to work correctly, you must setup your development environment correctly. The [Chickensoft Setup Docs][setup-docs] describe how to setup your Godot and C# development environment, following Chickensoft's best practices.
|
||||
|
||||
@@ -45,7 +45,7 @@ This template includes some Visual Studio Code settings in `.vscode/settings.jso
|
||||
|
||||
The included [`global.json`](./global.json) specifies the version of the .NET SDK that the included projects should use. It also specifies the `Godot.NET.Sdk` version that the included test project should use (since tests run inside an actual Godot game so you can use the full Godot API to verify your package is working as intended).
|
||||
|
||||
## 🐞 Debugging
|
||||
## Debugging
|
||||
|
||||
You can debug the included test project for your package in `GodotHelper.Tests/` by opening the root of this repository in VSCode and selecting one of the launch configurations: `Debug Tests` or `Debug Current Test`.
|
||||
|
||||
@@ -55,7 +55,7 @@ The launch profiles will trigger a build (without restoring packages) and then i
|
||||
|
||||
> **Important:** You must setup a `GODOT` environment variable for the launch configurations above. If you're using [GodotEnv] to install and manage Godot versions, you're already setup! For more info, see the [Chickensoft Setup Docs][setup-docs].
|
||||
|
||||
## 👷 Testing
|
||||
## Testing
|
||||
|
||||
By default, a test project in `GodotHelper.Tests/` is created for you to write tests for your package. [GoDotTest] is already included and setup, allowing you to focus on development and testing.
|
||||
|
||||
@@ -68,7 +68,7 @@ If you run Godot with the `--run-tests` command line argument, the game will run
|
||||
|
||||
Please see `test/ExampleTest.cs` and the [GoDotTest] readme for more examples.
|
||||
|
||||
## 🚦 Test Coverage
|
||||
## Test Coverage
|
||||
|
||||
Code coverage requires a few `dotnet` global tools to be installed first. You should install these tools from the root of the project directory.
|
||||
|
||||
@@ -94,11 +94,11 @@ cd GodotHelper.Tests
|
||||
|
||||
You can also run test coverage through VSCode by opening the command palette and selecting `Tasks: Run Task` and then choosing `coverage`.
|
||||
|
||||
## 🏭 CI/CD
|
||||
## CI/CD
|
||||
|
||||
This package includes various GitHub Actions workflows to make developing and deploying your package easier.
|
||||
|
||||
### 🚥 Tests
|
||||
### Tests
|
||||
|
||||
Tests run on every push or pull request to the repository. You can configure which platforms you want to run tests on in [`.github/workflows/tests.yaml`](.github/workflows/tests.yaml).
|
||||
|
||||
@@ -106,7 +106,7 @@ By default, tests run each platform (macOS, Windows, and Linux) using the latest
|
||||
|
||||
Tests are executed by running the Godot test project in `GodotHelper.Tests` from the command line and passing in the relevant arguments to Godot so that [GoDotTest] can discover and run tests.
|
||||
|
||||
### 🧑🏫 Spellcheck
|
||||
### Spellcheck
|
||||
|
||||
A spell check runs on every push or pull request to the repository. Spellcheck settings can be configured in [`.github/workflows/spellcheck.yaml`](.github/workflows/spellcheck.yaml)
|
||||
|
||||
@@ -116,7 +116,7 @@ You can also words to the local `cspell.json` file from VSCode by hovering over
|
||||
|
||||
|
||||
|
||||
### 📦 Release
|
||||
### Release
|
||||
|
||||
The included workflow in [`.github/workflows/release.yaml`](.github/workflows/publish.yaml) can be manually dispatched when you're ready to make a new release. Once you specify `major`, `minor`, or `patch` for the version bump strategy, the workflow will build your package with the updated version and release it on both GitHub and nuget.
|
||||
|
||||
@@ -124,7 +124,7 @@ The accompanying [`.github/workflows/auto_release.yaml`](.github/workflows/auto_
|
||||
|
||||
> To publish to nuget, you need to configure a repository or organization secret within GitHub named `NUGET_API_KEY` that contains your Nuget API key. Make sure you setup `NUGET_API_KEY` as a **secret** (rather than an environment variable) to keep it safe!
|
||||
|
||||
### 🏚 Renovatebot
|
||||
### Renovatebot
|
||||
|
||||
This repository includes a [`renovate.json`](./renovate.json) configuration for use with [Renovatebot]. Renovatebot can automatically open and merge pull requests to help you keep your dependencies up to date when it detects new dependency versions have been released.
|
||||
|
||||
@@ -140,7 +140,7 @@ If your project is setup to require approvals before pull requests can be merged
|
||||
|
||||
---
|
||||
|
||||
🐣 Package generated from a 🐤 Chickensoft Template — <https://chickensoft.games>
|
||||
Package generated from a Chickensoft Template — <https://chickensoft.games>
|
||||
|
||||
[chickensoft-badge]: https://chickensoft.games/img/badges/chickensoft_badge.svg
|
||||
[chickensoft-website]: https://chickensoft.games
|
||||
|
||||
Reference in New Issue
Block a user