Skip to content

Commit 39abe7c

Browse files
gimlichaelgimlichael
authored
housekeeping/updated to be contemporary (#1)
1 parent f08ee57 commit 39abe7c

26 files changed

+390
-122
lines changed

‎.docfx/BuildDocfxImage.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
$version = minver -i
1+
$version = minver -i -t v -v w
22
docfx metadata docfx.json
3-
docker build -t yourbranding/classlibrary1:$version -f Dockerfile.docfx .
3+
docker buildx build -t yourbranding/classlibrary1:$version --platform linux/arm64,linux/amd64 --load -f Dockerfile.docfx .
44
get-childItem -recurse -path api -include *.yml, .manifest | remove-item

‎.docfx/Dockerfile.docfx

+4-36
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,12 @@
1-
# escape=`
2-
3-
FROM nginx:1.25.4 AS base
1+
FROM nginx:1.27.0-alpine AS base
42
RUN rm -rf /usr/share/nginx/html/*
53

6-
FROM mono:6.12.0.182 AS build
7-
ARG DOCFX_VERSION=v2.75.3
8-
9-
ENV PATH ${PATH}:/opt/docfx
10-
ENV DOCFX_SOURCE_BRANCH_NAME="main"
11-
12-
# MONO IMAGE
13-
RUN curl -sSL --output packages-microsoft-prod.deb https://packages.microsoft.com/config/debian/11/packages-microsoft-prod.deb
14-
RUN dpkg -i packages-microsoft-prod.deb
15-
RUN apt-get update `
16-
&& apt-get install -y powershell zip apt-transport-https dirmngr gnupg ca-certificates git `
17-
&& mkdir -p /opt/docfx/ `
18-
&& curl -sSL --output docfx.zip "https://github.com/dotnet/docfx/releases/download/${DOCFX_VERSION}/docfx-linux-x64-${DOCFX_VERSION}.zip" `
19-
&& unzip docfx.zip -d /opt/docfx/ `
20-
&& rm docfx.zip `
21-
&& echo '#!/bin/bash' >> /opt/docfx/docfx `
22-
&& echo 'exec mono /opt/docfx/docfx.exe $@' >> /opt/docfx/docfx `
23-
&& chmod +x /opt/docfx/docfx `
24-
&& apt-get -y purge unzip
25-
26-
SHELL ["/opt/microsoft/powershell/7/pwsh", "-Command"]
27-
28-
WORKDIR /build
4+
FROM codebeltnet/docfx:2.77.0 AS build
295

306
ADD [".", "docfx"]
31-
#ADD ["src", "src"] INCLUDE THIS WHEN DOCFX IS MATURED - SEE NOTE BELOW
32-
33-
RUN cd docfx; `
34-
# docfx metadata; ` INCLUDE THIS WHEN DOCFX IS MATURED - SEE NOTE BELOW
35-
docfx build
367

37-
# After carefull considerations, I have concluded that DoxFx is not a matured product to be run entirely as part of a Docker image.
38-
# Reason is that for DocFx to resolve cref correctly (and assembly names) it requires the msbuild project file (csproj) and not only the source files (cs).
39-
# As stated by docfx team themself: Visual Studio 2019 is needed for docfx metadata msbuild projects.
40-
# Given that VS2019 is to hard a dependency, I have moved the docfx metadata taskto my local development environment.
41-
# It would have been great to have all documentation done in a container - but for now this is not an option without significant drawbacks.
8+
RUN cd docfx; \
9+
docfx build
4210

4311
FROM base AS final
4412
WORKDIR /usr/share/nginx/html

‎.docfx/PublishDocfxImage.ps1

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
1-
$version = minver -i
2-
docker tag sharedkernel-docfx:$version yourbranding/classlibrary1:$version
1+
$version = minver -i -t v -v w
2+
docker tag classlibrary1-docfx:$version yourbranding/classlibrary1:$version
33
docker push yourbranding/classlibrary1:$version

‎.docfx/api/namespaces/ClassLibrary1.md

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
uid: ClassLibrary1
3+
summary: *content
4+
---
5+
The `ClassLibrary1` namespace contains types that ...
6+
7+
[!INCLUDE [availability-default](../../includes/availability-default.md)]
8+
9+
Complements: [xUnit: Capturing Output](https://xunit.net/docs/capturing-output) 🔗
10+
11+
### Extension Methods
12+
13+
|Type|Ext|Methods|
14+
|--:|:-:|---|
15+
|ClassLibrary1|⬇️|`Awesome`|

‎.docfx/docfx.json

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
"files": [
2828
"api/**/*.yml",
2929
"api/**/*.md",
30+
"packages/**/*.md",
3031
"toc.yml",
3132
"*.md"
3233
],

‎.docfx/includes/availability-default.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Availability: .NET 8, .NET 6 and .NET Standard 2.0

‎.docfx/includes/availability-modern.md

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Availability: .NET 8 and .NET 6

‎.docfx/index.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
uid: frontpage-md
3+
title: ClassLibrary1
4+
---
5+
# ClassLibrary1
6+
7+
Landing page for ClassLibrary1.

‎.docfx/toc.yml

+4
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
- name: ClassLibrary1 API
2+
href: api/ClassLibrary1.html
3+
- name: NuGet
4+
href: packages

‎.github/CODE_OF_CONDUCT.md

+135
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,135 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
This document is adapted from the Contributor Covenant which is used by many open source projects,
4+
including those under the [.NET Foundation](https://dotnetfoundation.org/code-of-conduct).
5+
6+
## Our Pledge
7+
8+
We as members, contributors, and leaders pledge to make participation in our
9+
community a harassment-free experience for everyone, regardless of age, body
10+
size, visible or invisible disability, ethnicity, sex characteristics, gender
11+
identity and expression, level of experience, education, socio-economic status,
12+
nationality, personal appearance, race, caste, color, religion, or sexual identity
13+
and orientation.
14+
15+
We pledge to act and interact in ways that contribute to an open, welcoming,
16+
diverse, inclusive, and healthy community.
17+
18+
## Our Standards
19+
20+
Examples of behavior that contributes to a positive environment for our
21+
community include:
22+
23+
* Demonstrating empathy and kindness toward other people
24+
* Being respectful of differing opinions, viewpoints, and experiences
25+
* Giving and gracefully accepting constructive feedback
26+
* Accepting responsibility and apologizing to those affected by our mistakes,
27+
and learning from the experience
28+
* Focusing on what is best not just for us as individuals, but for the
29+
overall community
30+
31+
Examples of unacceptable behavior include:
32+
33+
* The use of sexualized language or imagery, and sexual attention or
34+
advances of any kind
35+
* Trolling, insulting or derogatory comments, and personal or political attacks
36+
* Public or private harassment
37+
* Publishing others' private information, such as a physical or email
38+
address, without their explicit permission
39+
* Other conduct which could reasonably be considered inappropriate in a
40+
professional setting
41+
42+
## Enforcement Responsibilities
43+
44+
Community leaders are responsible for clarifying and enforcing our standards of
45+
acceptable behavior and will take appropriate and fair corrective action in
46+
response to any behavior that they deem inappropriate, threatening, offensive,
47+
or harmful.
48+
49+
Community leaders have the right and responsibility to remove, edit, or reject
50+
comments, commits, code, wiki edits, issues, and other contributions that are
51+
not aligned to this Code of Conduct, and will communicate reasons for moderation
52+
decisions when appropriate.
53+
54+
## Scope
55+
56+
This Code of Conduct applies within all community spaces, and also applies when
57+
an individual is officially representing the community in public spaces.
58+
Examples of representing our community include using an official e-mail address,
59+
posting via an official social media account, or acting as an appointed
60+
representative at an online or offline event.
61+
62+
## Enforcement
63+
64+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
65+
reported to the community leaders responsible for enforcement at
66+
[INSERT CONTACT METHOD].
67+
All complaints will be reviewed and investigated promptly and fairly.
68+
69+
All community leaders are obligated to respect the privacy and security of the
70+
reporter of any incident.
71+
72+
## Enforcement Guidelines
73+
74+
Community leaders will follow these Community Impact Guidelines in determining
75+
the consequences for any action they deem in violation of this Code of Conduct:
76+
77+
### 1. Correction
78+
79+
**Community Impact**: Use of inappropriate language or other behavior deemed
80+
unprofessional or unwelcome in the community.
81+
82+
**Consequence**: A private, written warning from community leaders, providing
83+
clarity around the nature of the violation and an explanation of why the
84+
behavior was inappropriate. A public apology may be requested.
85+
86+
### 2. Warning
87+
88+
**Community Impact**: A violation through a single incident or series
89+
of actions.
90+
91+
**Consequence**: A warning with consequences for continued behavior. No
92+
interaction with the people involved, including unsolicited interaction with
93+
those enforcing the Code of Conduct, for a specified period of time. This
94+
includes avoiding interactions in community spaces as well as external channels
95+
like social media. Violating these terms may lead to a temporary or
96+
permanent ban.
97+
98+
### 3. Temporary Ban
99+
100+
**Community Impact**: A serious violation of community standards, including
101+
sustained inappropriate behavior.
102+
103+
**Consequence**: A temporary ban from any sort of interaction or public
104+
communication with the community for a specified period of time. No public or
105+
private interaction with the people involved, including unsolicited interaction
106+
with those enforcing the Code of Conduct, is allowed during this period.
107+
Violating these terms may lead to a permanent ban.
108+
109+
### 4. Permanent Ban
110+
111+
**Community Impact**: Demonstrating a pattern of violation of community
112+
standards, including sustained inappropriate behavior, harassment of an
113+
individual, or aggression toward or disparagement of classes of individuals.
114+
115+
**Consequence**: A permanent ban from any sort of public interaction within
116+
the community.
117+
118+
## Attribution
119+
120+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
121+
version 2.0, available at
122+
[https://www.contributor-covenant.org/version/2/0/code_of_conduct.html][v2.0].
123+
124+
Community Impact Guidelines were inspired by
125+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
126+
127+
For answers to common questions about this code of conduct, see the FAQ at
128+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available
129+
at [https://www.contributor-covenant.org/translations][translations].
130+
131+
[homepage]: https://www.contributor-covenant.org
132+
[v2.0]: https://www.contributor-covenant.org/version/2/0/code_of_conduct.html
133+
[Mozilla CoC]: https://github.com/mozilla/diversity
134+
[FAQ]: https://www.contributor-covenant.org/faq
135+
[translations]: https://www.contributor-covenant.org/translations

‎.github/CONTRIBUTING.md

+52
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
# Contributing to `Classlibrary1`
2+
When contributing to this repository, please first discuss the change you wish to make via issue,
3+
email, or any other method with the owners of this repository before making a change.
4+
5+
Please note we have a code of conduct, please follow it in all your interactions with the project.
6+
7+
## Code of Conduct
8+
Please review our [code of conduct](CODE_OF_CONDUCT.md).
9+
10+
## Our Development Process
11+
We use `trunk` based branching model that is aligned with todays DevSecOps practices.
12+
All new features and/or fixes are merged into the `main` branch by creating a Pull Request.
13+
14+
## Pull Requests
15+
We actively welcome your pull requests.
16+
17+
1. Fork the repo and create your branch from `main`
18+
2. If you've added code that should be tested, add tests (DO follow [Microsoft Engineering Guidelines](https://github.com/dotnet/aspnetcore/wiki/Engineering-guidelines))
19+
3. Any changes or additions requires documentation in the form of documenting public members
20+
4. Ensure that all existing as well as new test passes
21+
5. Issue that pull request with a big and heartful thanks for contributing
22+
23+
## Issues
24+
We use GitHub issues to track public bugs. Please ensure your description is
25+
clear and has sufficient instructions to be able to reproduce the issue.
26+
27+
## Coding Guidelines
28+
* Please follow [Framework Design Guidelines](https://learn.microsoft.com/en-us/dotnet/standard/design-guidelines/)
29+
* Please follow SOLID principles
30+
* Please follow [Microsoft Engineering Guidelines](https://github.com/dotnet/aspnetcore/wiki/Engineering-guidelines)
31+
32+
## Manifesto
33+
As aspiring Software Craftsmen we are raising the bar of professional software development by practicing it and helping others learn the craft.
34+
35+
Through this work we have come to value:
36+
37+
* Not only working software,
38+
but also well-crafted software
39+
* Not only responding to change,
40+
but also steadily adding value
41+
* Not only individuals and interactions,
42+
but also a community of professionals
43+
* Not only customer collaboration,
44+
but also productive partnerships
45+
46+
That is, in pursuit of the items on the left we have found the items on the right to be indispensable.
47+
48+
[Manifesto for Software Craftsmanship](https://manifesto.softwarecraftsmanship.org/) is the originator of this text.
49+
50+
## License
51+
By contributing to `ClassLibrary1`, you agree that your contributions will be licensed
52+
under the MIT license.

‎.codecov/codecov.yml renamed to ‎.github/codecov.yml

File renamed without changes.

‎.github/dependabot.yml

+12-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,17 @@
11
version: 2
22
updates:
3+
- package-ecosystem: "nuget"
4+
directory: "/src"
5+
schedule:
6+
interval: "weekly"
7+
open-pull-requests-limit: 0
8+
- package-ecosystem: "nuget"
9+
directory: "/test"
10+
schedule:
11+
interval: "weekly"
12+
open-pull-requests-limit: 0
313
- package-ecosystem: "github-actions"
4-
directory: "/"
14+
directory: "/.github/workflows"
515
schedule:
616
interval: "weekly"
17+
open-pull-requests-limit: 0

0 commit comments

Comments
 (0)