Skip to content

Commit 1a66056

Browse files
FalcionFalcion
authored
Merge pull request #224 from Falcion/release/v2.3.0
chore(release): 2.3.0
2 parents 5ef3c93 + 2de2ee5 commit 1a66056

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+2001
-345
lines changed

‎.changeset/.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
*.md
1+
!*.md

‎.changeset/five-suns-buy.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'patternugit': minor
3+
---
4+
5+
Fixed depedency tree (more - with eslint) in package's dependencies.

‎.changeset/new-seals-tell.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'patternugit': patch
3+
---
4+
5+
add changesets, optimized workflows for build-checks

‎.changeset/olive-elephants-play.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'patternugit': patch
3+
---
4+
5+
fix lint integration with CHANGELOG crashing patches and ignore .MD files in changesets

‎.commitlintrc.json

Lines changed: 0 additions & 3 deletions
This file was deleted.

‎.github/ISSUE_TEMPLATE/01_bug_report.yml

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -43,29 +43,29 @@ body:
4343
label: Version of an project's essence
4444
description: What version of an project's essence are you running.
4545
options:
46-
- v0.1.0
47-
- v0.2.0
48-
- v0.2.1
49-
- v0.2.2
50-
- v0.2.3
51-
- v0.2.4
52-
- v0.3.0
53-
- v0.3.1
54-
- v0.3.2
55-
- v0.3.3
56-
- v0.3.4
57-
- v0.3.5
58-
- v1.0.0
59-
- v1.0.1
60-
- v2.0.0
61-
- v2.1.0
62-
- v2.1.1
63-
- v2.1.2
64-
- v2.1.3
65-
- v2.1.4
66-
- v2.1.5
67-
- v2.1.6
46+
- v2.3.0
6847
- v2.2.0
48+
- v2.1.6
49+
- v2.1.4
50+
- v2.1.3
51+
- v2.1.2
52+
- v2.1.1
53+
- v2.1.0
54+
- v2.0.0
55+
- v1.0.1
56+
- v1.0.0
57+
- v0.3.5
58+
- v0.3.4
59+
- v0.3.3
60+
- v0.3.2
61+
- v0.3.1
62+
- v0.3.0
63+
- v0.2.4
64+
- v0.2.3
65+
- v0.2.2
66+
- v0.2.1
67+
- v0.2.0
68+
- v0.1.0
6969
- Another or unknown
7070
default: 1
7171
validations:

‎.github/PHILOSOPHY.md

Lines changed: 103 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,103 @@
1+
Let's start with the simplest and most introductory essence of the philosophy of
2+
the PATTERNU project - it defines the philosophy of those projects that use things
3+
surrounding its philosophy (scripts, CI/CD, etc.) if they have not designated their
4+
own philosophy in the same document, i.e. PATTERNU designates a template of philosophical
5+
and program behavior for these projects, this is one of its fundamental
6+
aspirations - to arrange what is not arranged initially and what a potential developer
7+
(or creator) does not want to arrange, a ready-made infrastructure, an idea, documentation
8+
on all planes.
9+
10+
PATTERNU perceives that each project is to some extent individual, that each developer
11+
is even more individual, therefore it does not try to impose, but only to designate
12+
and indicate.
13+
14+
**What does it mean?**
15+
16+
The project is trying to provide such functionality that if you forgot to configure
17+
something, specify it separately, or mark it, then PATTERNU will directly indicate
18+
it to you, or will make it so that you actually did not worry about it to one degree
19+
or another. Its main goal is to simplify the initial stage of the project's life,
20+
and not to replace the business process of the project in general, it does not try
21+
to build itself more than a project "template", this is not its goal, its goal is
22+
to become a project for other projects and allow people who are not interested in
23+
DevOps, writing basic documentation, etc. to cross the threshold of open-source
24+
frameworks and professional features and do what most programmers love - programming.
25+
26+
All those things that form the basis of the project, its life cycle - are an integral
27+
part of the project itself, but they do not necessarily have to be "independent",
28+
"brilliant", self-written - their miracle is that they can be taken from others and
29+
shared. PATTERNU tries to "comprehend" such a thought in the absolute, including
30+
in the form of this philosophy - all those things that surround the future project
31+
that uses this template, develop this philosophy and the project itself does not
32+
necessarily have its own philosophy, it is enough for it to have a goal and functionality,
33+
and the role of a philosopher will be taken by the PATTERNU project.
34+
35+
We do not delve into analytical, classical philosophy, metaphysics and others because
36+
PATTERNU sets applied philosophy as its goal, i.e. its direct function is a worldview
37+
or simply reasoning.
38+
39+
## Basic principles
40+
41+
### 1. **Simplify the initial stage**
42+
43+
PATTERNU aims to make the first steps in project development as easy as possible:
44+
45+
- If you forgot to specify or configure something, PATTERNU will remind you about
46+
it.
47+
- If you do not want to deal with DevOps, CI/CD setup or writing basic documentation,
48+
PATTERNU will take this work on itself.
49+
- PATTERNU creates a ready-made infrastructure that allows you not to worry about
50+
basic processes, focusing on writing code.
51+
52+
### 2. **No more than a template**
53+
54+
PATTERNU does not try to replace your project's business processes or impose strict
55+
frameworks. This is exactly a *template* that offers:
56+
57+
- Basic tools and recommendations for a start.
58+
- Documentation and examples for understanding.
59+
- Flexibility for customization to individual needs.
60+
61+
### 3. **Philosophy for other projects**
62+
63+
PATTERNU realizes that not every project needs its own philosophy. Instead, it
64+
provides a *philosophy template* that can be used as a basis:
65+
66+
- A project only needs a goal and functionality.
67+
- PATTERNU takes care of the philosophical aspects, allowing the developer to
68+
focus on the code.
69+
70+
### 4. **The idea of ​​sharing**
71+
72+
PATTERNU supports the concept of sharing:
73+
74+
- Use ready-made solutions when possible.
75+
- Share your improvements with others.
76+
- Don't be afraid to borrow tools and practices that have already proven their effectiveness.
77+
78+
## Why do we need applied philosophy?
79+
80+
PATTERNU is based on the idea of ​​*applied philosophy*, avoiding complex analytical
81+
theories and metaphysics. We focus on:
82+
83+
- A worldview that helps organize projects.
84+
- Practical reasoning on how to make development more convenient.
85+
86+
## How to use PATTERNU?
87+
88+
1. **For developers who want to focus on programming.**
89+
PATTERNU removes the need for you to do basic project setup.
90+
91+
2. **For projects that want simplified management.**
92+
Use built-in templates for CI/CD, documentation, and repository organization.
93+
94+
3. **For open-source enthusiasts.**
95+
PATTERNU helps you overcome the entry threshold by providing ready-made tools for
96+
publishing and maintaining a project.
97+
98+
## Conclusion
99+
100+
PATTERNU is a template not only for code, but also for ideas. It is a project that
101+
helps other projects find their structure and philosophy. Choose PATTERNU to focus
102+
on what is important to you: writing code, creating features, and developing your
103+
idea. We have already prepared the rest.

‎.github/RELEASE_NOTES_TEMPLATE.md

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# Release Notes Template for Public Releases
2+
3+
> [!Note]
4+
> This template is specifically designed for *public releases* displayed on the
5+
> "Releases" page of a project hosted on GitHub. For "hard" templates, i.e., local
6+
> release files stored in the repository, please refer to the following document:
7+
>
8+
> - [release/data/PATTERN.md](./../release/data/PATTERN.md)
9+
10+
The release notes template consists of several sections: the header, body (introduction,
11+
body title, content), footer, and a separate technical section.
12+
13+
## Template Structure
14+
15+
### 1. Header
16+
17+
The header should represent the version tag of the release, following the semantic
18+
versioning standard. The `v*` prefix is optional and depends on your technical requirements
19+
or personal preference, as well as any suffixes used under the [SemVer](https://semver.org/)
20+
specification.
21+
22+
### 2. Body of the Release
23+
24+
The body forms the core of the release notes and contains the following components:
25+
26+
#### 2.1. Introduction
27+
28+
This is a brief introduction or description of the release. It succinctly explains
29+
the purpose or key aspects of the current version.
30+
31+
#### 2.2. Body Title
32+
33+
Unlike the technical header, this title is a descriptive, human-readable summary
34+
of the release and its main content.
35+
36+
#### 2.3. Content
37+
38+
This section describes the implemented changes, fixes, and other updates. The content
39+
can be presented either in **essay format** or as a **list**, depending on your
40+
preference or audience.
41+
42+
#### 2.4. Footer
43+
44+
The footer typically includes a reference to the changelog or a link to the local
45+
release version stored in the repository. This serves as a more technical publication
46+
of the release’s changelog.
47+
48+
## Technical Guidelines for Releases and Patch Notes
49+
50+
To ensure proper management and publication of release notes, adhere to the following
51+
best practices:
52+
53+
1. **Commit Management**
54+
Always monitor the last commit to which the release or tag will be attached.
55+
This ensures consistency and accuracy in versioning.
56+
2. **Semantic Versioning**
57+
Understand and maintain the logical flow of version numbers according to semantic
58+
versioning. Verify their accuracy before publication.
59+
3. **Pre-release Tags**
60+
Avoid using "pre-release" tags unless necessary. These are suitable for development
61+
versions, beta releases, or other testing phases.
62+
4. **Target Branch**
63+
Set the release target (target menu upon release) to the **default branch**
64+
of your project.
65+
- **Exceptions:** This rule can only be violated if explicitly documented as
66+
part of the workflow (e.g., Public Beta Environment releases).
67+
5. **Attachments**
68+
If your project does not require attached files for releases, follow these guidelines:
69+
- **Patches:** Never attach binary files.
70+
- **Minor Versions:** Attach files only when necessary.
71+
- **Major Versions:** Always attach files to provide comprehensive context and
72+
resources.
73+
6. **Proper Use of Tags**
74+
Use tags in accordance with their purpose. If there are no external requirements,
75+
prioritize tags based on SemVer and any automated release systems integrated
76+
into your workflow.
77+
**Do not forget to use "set as the latest release" parameter upon creating release.**
78+
79+
## Example of Release Notes Using This Template
80+
81+
Below is an example illustrating how to use this template for a specific release:
82+
83+
```md
84+
# 3.0.0
85+
86+
This update is the largest update in this plugin and probably forever to be fixed as the largest update in the history of the plugin, the number of innovations and other things exceeds the ability to write a patch note, so let's go in brief.
87+
88+
## Major update: implementing code editor and many other things
89+
90+
### Code editor
91+
92+
The plugin now allows you to literally edit code with syntax highlighting, including all the necessary parameters to customize the interface, from minimapping to ligatures and font assignments.
93+
94+
- **now you can also edit fence (code) blocks as code files!**
95+
96+
### Localization support
97+
98+
Now the plugin "FULLY" supports all languages that are in the app, you can make a translation into your language and integrate it into the plugin and every visual element of it would be translated.
99+
100+
### Backward compatibility
101+
102+
Now the plugin, with the backward compatibility module enabled, tries to adapt your settings from older versions of the plugin to the newer ones: sometimes can be broken.
103+
104+
### Official wiki
105+
106+
The plugin has reached such a size that it needs separate documentation and a wikipedia explaining some things and its separate functionality: the ultimate goal of the wikipedia is to become a knowledge base not only for the plugin, but also with related things.
107+
108+
**WIKIPEDIA IS STILL IN DEVELOPMENT.**
109+
110+
### Bugfixes and optimizations
111+
112+
Some popular plugins, issues, and implicit optimization problems (like spamming errors like in #70 or memory overload in extension registration) have been fixed.
113+
114+
### And even more
115+
116+
> [!Important]
117+
> Read more about what has been introduced to the plugin in the special release note:
118+
> https://github.com/Falcion/UNITADE.md/blob/main/data/release/v3.0.0.md

‎.github/RELEASE_TEMPLATE.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
---
2+
tag: X.X.X
3+
previous_tag: auto
4+
target: main (master)
5+
set as the latest release: true
6+
set as a pre-release: false
7+
---
8+
# X.X.X
9+
10+
INTRODUCTION HERE.
11+
12+
## HEADER WITH THEME OF THE RELEASE
13+
14+
BODY (CHANGES) OF THE RELEASE.
15+
16+
> [!Important]
17+
> FOOTER WITH LINK:
18+
> <https://github.com/X/Y/blob/main/path/to/file>

‎.github/badges-status-presets.json

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"maintenance": "https://img.shields.io/badge/status-maintenance-crimson",
3+
"archived": "https://img.shields.io/badge/status-archived-lightseagreen",
4+
"development": {
5+
"active": "https://img.shields.io/badge/status-development-dodgerblue",
6+
"pending": "https://img.shields.io/badge/status-pending-orangered"
7+
}
8+
}

‎.github/labeler.yml

Lines changed: 21 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,20 +2,30 @@
22
# code-scanning:
33
# - code-scanning/**/*
44
documentation:
5-
- 'docs/**/*'
5+
- changed-files:
6+
- any-glob-to-any-file: 'docs/**'
67
automation/ci-cd:
7-
- '.github/workflows/**/*'
8-
- '.github/*.yml'
8+
- changed-files:
9+
- any-glob-to-any-file: ['.github/workflows/**', '.github/*.yml']
910
automation/tooling:
10-
- 'kubernetes/**/*'
11+
- changed-files:
12+
- any-glob-to-any-file: 'kubernetes/**'
1113
dependencies:
12-
- '**/package*'
13-
- '**/composer*'
14-
- '**/yarn*'
15-
- '**/requirements'
14+
- changed-files:
15+
- any-glob-to-any-file: ['**/package*', '**/composer*', '**/yarn*', '**/requirements*']
1616
main:
17-
- 'source/**/*'
17+
- changed-files:
18+
- any-glob-to-any-file: 'source/**'
1819
python:
19-
- '**/*.py'
20+
- changed-files:
21+
- any-glob-to-any-file: '**/*.py'
2022
release:
21-
- 'release/**/*'
23+
- changed-files:
24+
- any-glob-to-any-file: 'release/**'
25+
- base-branch: 'release*'
26+
javascript:
27+
- changed-files:
28+
- any-glob-to-any-file: '**/*.js'
29+
github_actions:
30+
- changed-files:
31+
- any-glob-to-any-file: ['.github/workflows/**', '.github/*.yml']

0 commit comments

Comments
 (0)