Skip to content
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

Release #29

Merged
merged 4 commits into from
Sep 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
25 changes: 25 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug
about: Software defect.
labels: [ bug ]
---

**REPLACE WITH BUG DETAILS** (Check below for guidelines)

---

Describe the steps and expected results:

```
Given *a condition*
And *another condition*
When *an action is taken*
And *other after the first*
Then *something happened*
And I expected *this other thing*
```

If it is possible, please include:
* The code that produced the error (or a link to it)
* Stack trace of the error and/or logs if available
* Details on the environment the fail happened (i.e.: the OS)
21 changes: 21 additions & 0 deletions .github/ISSUE_TEMPLATE/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Enhancement
about: New feature or improvement.
labels: [ enhancement ]
---

**REPLACE WITH ENHANCEMENT DETAILS** (Check below for guidelines)

---

Detailed description.

Reason for the change or new development.

Acceptance criteria to verify the development. A list of requirements with the following format:

`When *action* then *result*`

For example:

`When this is done then that other thing should happen`
15 changes: 15 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

**REPLACE WITH PR DESCRIPTION** (It is also editable after PR creation)

---

For the Pull Request to be accepted please check:

- [ ] The PR has a meaningful title.
- [ ] If the PR refers to an issue, it should be referenced with the GitHub format (*#ID*).
- [ ] The PR is done to the `develop` branch (new features) or the `master` branch (releases).
- [ ] The code pass all PR checks.
- [ ] All public members are documented.
- [ ] The code follow the coding conventions stated at the [contributing.md] file.

[contributing.md]: https://github.com/jaguililla/hexagonal_spring/blob/main/CONTRIBUTING.md
8 changes: 3 additions & 5 deletions .gitlab-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,7 @@ build:
stage: build
image: ubuntu:24.04
rules:
- if: $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH
- if: $CI_PIPELINE_SOURCE == "push"
- if: $CI_COMMIT_BRANCH != $CI_DEFAULT_BRANCH && $CI_PIPELINE_SOURCE == "push"
cache:
key: build-cache
paths:
Expand All @@ -37,8 +36,7 @@ publish:
stage: release
image: maven:3
rules:
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH
- if: $CI_PIPELINE_SOURCE == "push"
- if: $CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH && $CI_PIPELINE_SOURCE == "push"
before_script:
- apt update
- apt -y install curl zip unzip
Expand All @@ -55,7 +53,7 @@ publish:
- export IMG_REGISTRY="image.registry=${CI_REGISTRY}/jaguililla/hexagonal_spring"
- export POM_VERSION="$(mvn help:evaluate -D expression=project.version -q -D forceStdout)"
- export CI_PUBLISH="spring-boot.build-image.publish=true"
- export MAVEN_ARGS="--quiet --batch-mode --settings .mvn/ci_settings.xml"
- export MAVEN_ARGS="--quiet --batch-mode --settings .gitlab/ci_settings.xml"
- ./mvnw -D ${ALT_REPOSITORY} -D ${IMG_REGISTRY} -D ${CI_PUBLISH} deploy
- rm -rf "${CLIENT_PATH}/src/main/java/${CONTROLLERS_PATH}"
- mvn -f "${CLIENT_PATH}/pom.xml" -D ${ALT_REPOSITORY} clean deploy
Expand Down
File renamed without changes.
25 changes: 25 additions & 0 deletions .gitlab/issue_templates/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
---
name: Bug
about: Software defect.
labels: [ bug ]
---

**REPLACE WITH BUG DETAILS** (Check below for guidelines)

---

Describe the steps and expected results:

```
Given *a condition*
And *another condition*
When *an action is taken*
And *other after the first*
Then *something happened*
And I expected *this other thing*
```

If it is possible, please include:
* The code that produced the error (or a link to it)
* Stack trace of the error and/or logs if available
* Details on the environment the fail happened (i.e.: the OS)
21 changes: 21 additions & 0 deletions .gitlab/issue_templates/enhancement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
name: Enhancement
about: New feature or improvement.
labels: [ enhancement ]
---

**REPLACE WITH ENHANCEMENT DETAILS** (Check below for guidelines)

---

Detailed description.

Reason for the change or new development.

Acceptance criteria to verify the development. A list of requirements with the following format:

`When *action* then *result*`

For example:

`When this is done then that other thing should happen`
15 changes: 15 additions & 0 deletions .gitlab/merge_request_templates/mr.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@

**REPLACE WITH PR DESCRIPTION** (It is also editable after PR creation)

---

For the Pull Request to be accepted please check:

- [ ] The PR has a meaningful title.
- [ ] If the PR refers to an issue, it should be referenced with the GitHub format (*#ID*).
- [ ] The PR is done to the `develop` branch (new features) or the `master` branch (releases).
- [ ] The code pass all PR checks.
- [ ] All public members are documented.
- [ ] The code follow the coding conventions stated at the [contributing.md] file.

[contributing.md]: https://github.com/jaguililla/hexagonal_spring/blob/main/CONTRIBUTING.md
45 changes: 45 additions & 0 deletions .mvn/parent.xml
Original file line number Diff line number Diff line change
Expand Up @@ -299,5 +299,50 @@
</plugins>
</build>
</profile>

<profile>
<id>checkstyle</id>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.5.0</version>
<configuration>
<encoding>UTF-8</encoding>
<failsOnError>true</failsOnError>
<linkXRef>false</linkXRef>
</configuration>
<executions>
<execution>
<id>validate</id>
<phase>validate</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
</plugins>
</build>

<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId>
<version>3.5.0</version>
<reportSets>
<reportSet>
<reports>
<report>checkstyle</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
</profile>
</profiles>
</project>
7 changes: 7 additions & 0 deletions doc/commit_template.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@


# Summary in imperative mood [#TaskId] [:Tag] [!!!]
#
# [Details. Used to explain what and why vs. how]
#
# https://github.com/jaguililla/hexagonal_spring/blob/main/doc/commits.md
14 changes: 14 additions & 0 deletions doc/commits.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@

```
Summary in imperative mood [#TaskId] [:Tag] [!!!]

[Details. Used to explain what and why vs. how]
```

1. Capitalize summary line
2. Do not end summary line with a period
3. Elements among square brackets are optional
4. You can set multiple tags. I.e.: :doc :test
5. Tags are case-insensitive
6. Tags can be placed anywhere (even title start)
7. Summary with '!!!' means breaking changes