Skip to content

Refactors Arcus repository for an "intermediate" 3.x.y release #60

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 22 commits into from
Mar 10, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
22 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions .config/dotnet-tools.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
{
"version": 1,
"isRoot": true,
"tools": {
"csharpier": {
"version": "0.30.6",
"commands": [
"dotnet-csharpier"
],
"rollForward": false
},
"dotnet-outdated-tool": {
"version": "4.6.7",
"commands": [
"dotnet-outdated"
],
"rollForward": false
},
"husky": {
"version": "0.7.2",
"commands": [
"husky"
],
"rollForward": false
}
}
}
37 changes: 37 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Root .editorconfig as of 2025-02-03

root = true

# All files
[*]
charset = utf-8-bom
end_of_line = lf
indent_size = 4
indent_style = space
insert_final_newline = true
trim_trailing_whitespace = true

spelling_languages = en-us
spelling_checkable_types = strings,identifiers,comments
spelling_error_severity = information
spelling_exclusion_path = .\dictionary.dic

# json
[*.json]
indent_size = 2

# YAML Files
[*.{yml,yaml}]
indent_size = 2

# Bash Files
[*.sh]
end_of_line = lf

# Batch Files
[*.{cmd,bat,ps1}]
end_of_line = crlf

# XML
[*.xml]
indent_size = 2
3 changes: 1 addition & 2 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -23,5 +23,4 @@
# intervention with every merge. To do so, just uncomment the entries below
###############################################################################
*.sln merge=binary
*.csproj merge=binary
#*.vbproj merge=binary
*.csproj merge=binary
35 changes: 10 additions & 25 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,41 +1,26 @@
---
name: Bug report
about: Create a bug report to help us improve
name: Bug Report
about: Create a report to help us improve
title: "[BUG]"
labels: bug
assignees: ''

---

# Describe the bug
# Bug Report

A clear and concise description of what the bug is.
If available include the exception that is thrown, including the type and the included message and stack trace.
## Describe the bug

# Expected behavior
A clear and concise description of what the bug is.

A clear and concise description of what you expected to happen.

# Example of how to Reproduce

Provide the steps to reproduce the behavior by including a code example either inline or via a [Gist](https://gist.github.com/) link.
If a code example is not possible, or too complex for the context of the issue describe in detail

# Code Information
## How to Reproduce

- Runtime Information [e.g. netcore2.0, netstandard2.1]
- SDK / Runtime Version [e.g. Core 2.2 SDK 2.2.402]
- Language Version [e.g. C# 7.3, F# 4.6]
- Operating System [e.g. Linux, Windows 10, Mac]
Steps to reproduce the behavior.

# Proposed solutions
## Expected Behavior

Do you have a solution that may fix this issue?

# Can you help?

Let us know if you are interested in helping, and in what capacity. e.g.: I want to write code and create a pull request, I can provide test cases, I have a suggestion on how it can be done, etc.
A clear and concise description of what you expected to happen.

# Additional context
## Additional context

Add any other context about the problem here.
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/documentation-needed.md

This file was deleted.

29 changes: 13 additions & 16 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,30 @@
---
name: Feature request
name: Feature Request
about: Suggest an idea for this project
title: "[Feature Request]"
title: "[REQUEST]"
labels: enhancement
assignees: ''

---

# Description
# Feature Request

A clear and concise description of what the desired feature is.
## Is your feature request related to missing applicable functionality?

Is your feature request related to an existing problem? Please describe it and/or provide an issue number.
A clear and concise description of what the missing functionality. Please include RFCs or references as appropriate.

# Proposed solutions
## Proposed Solutions

Do you have a solution, what would you recommend to fix it?
If you don't have a solution what would you like the end result to be?
A clear and concise description of what you would like to see as a result.

# Can you help?

Let us know if you are interested in helping, and in what capacity. e.g.: I want to write code and create a pull request, I can provide test cases, I have a suggestion on how it can be done, etc.
## Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

# Describe alternatives you've considered
# Can you help?

Did you consider any alternatives solutions or features?
Did you have a workaround that met your needs?
Let us know if you are interested in helping, and in what capacity. e.g.: I want to write code and create a pull request, I can provide test cases, I have a suggestion on how it can be done, etc.

# Additional context
## Additional context

Add any other context about the problem here.
Add any other context or screenshots about the feature request here.
36 changes: 0 additions & 36 deletions .github/ISSUE_TEMPLATE/technical-debt.md

This file was deleted.

23 changes: 23 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Dependabot Configuration for .NET Project

version: 2
updates:
- package-ecosystem: "nuget"
directory: "/src"
schedule:
interval: "weekly"
day: "sunday"
allow:
- dependency-type: direct
ignore:
- dependency-name: "*"
update-types:
- "version-update:semver-patch"
commit-message:
prefix: "Dependabot package update"
open-pull-requests-limit: 5
- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
day: "sunday"
21 changes: 14 additions & 7 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,26 @@
Hello, and welcome! Thanks you for your contribution to **Arcus**.
# Arcus Pull Request

Thank you for your contribution to **Arcus**. Please answer the following questions regarding your pull request:

---

1. Please let us know about the contribution you are making
- [ ] Does this contribution update documentation?
- [ ] Does this contribution update code?
- [ ] Does it fix a bug?
- [ ] Does it add new functionality?
- [ ] Does it add new functionality?

2. Assuming there is a code change in this contribution
1. Assuming there is a code change in this contribution
- [ ] Have you included unit test(s) to verify the change?
- [ ] Do all pre-existing unit tests pass as expected?
- [ ] Does the change break existing functionality, if so have you explained why doing so is necessary?
- [ ] Have you listed the possible side-effects or negative impacts of the code change.
- [ ] Have you listed the possible side-effects or negative impacts of code changes.

1. Put `closes #XXXX` in your comment, where `XXXX` is the the issue that your PR addresses.

- If and issue does not yet exist, please create one before continuing

3. Put `closes #XXXX` in your comment, where XXXX is the the issue that your PR fixes.
4. Provide any other information that pertinent to the PR you're making.
5. Click "Create pull request".
1. Provide any other information that pertinent to the PR you're making.
1. Submit your Pull Request

Thanks again, we'll review your PR and and act accordingly.
41 changes: 41 additions & 0 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# .NET Build and Test Workflow

name: Build and Test

permissions:
contents: read
pull-requests: write

on:
push:
branches: ["main"]
pull_request:
branches: ["main"]

jobs:
build:
runs-on: windows-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup .NET SDKs
uses: actions/setup-dotnet@v4
with:
# .net 4.8.x is included by default in windows-latest
dotnet-version: |
8.0.x
9.0.x

- name: Restore dotnet tools
run: dotnet tool restore

- name: Restore dependencies
run: dotnet restore ./src

- name: Build
run: dotnet build ./src --no-restore -p:VersionFromCI="0.0.0-cibuild"

- name: Test
run: dotnet test ./src --no-build --verbosity normal
53 changes: 53 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# .NET Publish semver tag Workflow

name: Publish .NET Package

permissions:
contents: read
packages: write
pull-requests: write

on:
push:
tags:
- "v*.*.*"
- "v*.*.*-*"

jobs:
build:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Setup .NET
uses: actions/setup-dotnet@v4
with:
dotnet-version: 9.0.x

- name: Extract version
id: extract_version
run: echo "VERSION=${GITHUB_REF#refs/tags/v}" >> $GITHUB_ENV

- name: Restore dotnet tools
run: dotnet tool restore

- name: Restore dependencies
run: dotnet restore ./src

- name: Build
run: dotnet build ./src --no-restore --configuration Release /p:VersionFromCI=${{ env.VERSION }}

- name: Pack
run: dotnet pack ./src/Gulliver/Gulliver.csproj --configuration Release --no-build --output ./packages /p:VersionFromCI=${{ env.VERSION }}

- name: Publish to GitHub Packages
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: dotnet nuget push ./packages/*.nupkg --source "https://nuget.pkg.github.com/sandialabs/index.json" --api-key $GITHUB_TOKEN --skip-duplicate

- name: Publish to nuget.org
env:
NUGET_ORG_APIKEY: ${{ secrets.NUGET_ORG_APIKEY }}
run: dotnet nuget push ./packages/*.nupkg --source "https://api.nuget.org/v3/index.json" --api-key $NUGET_ORG_APIKEY --skip-duplicate
Loading