Skip to content

Commit

Permalink
up
Browse files Browse the repository at this point in the history
  • Loading branch information
yegor256 committed Oct 28, 2024
1 parent 9a09ddb commit 9f01ae0
Show file tree
Hide file tree
Showing 3 changed files with 95 additions and 5 deletions.
40 changes: 40 additions & 0 deletions .github/workflows/markdown-lint.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
# The MIT License (MIT)
#
# Copyright (c) 2022-2024 Objectionary.com
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
---
name: markdown-lint
'on':
push:
branches:
- master
pull_request:
branches:
- master
paths-ignore: ['paper/**', 'sandbox/**']
concurrency:
group: markdown-lint-${{ github.ref }}
cancel-in-progress: true
jobs:
markdown-lint:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- uses: articulate/actions-markdownlint@v1
42 changes: 42 additions & 0 deletions .github/workflows/up.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# The MIT License (MIT)
#
# Copyright (c) 2023-2024 Yegor Bugayenko
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the "Software"), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
# SOFTWARE.
---
name: up
on:
push:
jobs:
up:
runs-on: ubuntu-24.04
steps:
- uses: actions/checkout@v4
- run: |-
git fetch --tags --force && \
latest=$(git tag --sort=creatordate | tail -1) && \
sed -E -i "s/<version>[^<]+/<version>${latest}/g" README.md
- uses: peter-evans/create-pull-request@v7
with:
commit-message: 'new version in README'
delete-branch: true
title: 'New version in README'
assignees: yegor256
branch: up
base: master
18 changes: 13 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# Classpath Resources as JUnit Params

[![EO principles respected here](https://www.elegantobjects.org/badge.svg)](https://www.elegantobjects.org)
[![DevOps By Rultor.com](http://www.rultor.com/b/objectionary/jucs)](http://www.rultor.com/p/objectionary/jucs)
[![We recommend IntelliJ IDEA](https://www.elegantobjects.org/intellij-idea.svg)](https://www.jetbrains.com/idea/)
Expand All @@ -10,20 +12,23 @@
[![Hits-of-Code](https://hitsofcode.com/github/objectionary/jucs)](https://hitsofcode.com/view/github/objectionary/jucs)
[![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/objectionary/jucs/blob/master/LICENSE.txt)

There is a simple [`@ClasspathSource`](https://www.javadoc.io/doc/org.eolang/jucs/latest/org/eolang/jucs/ClasspathSource.html)
There is a simple [`@ClasspathSource`][annotation]
annotation in this package. It may help you
turn files, which are available in classpath, into sources of a JUnit5 test method.
turn files, which are available in classpath, into
sources of a JUnit5 test method.

First, add this to your `pom.xml`:

```xml
<dependency>
<groupId>org.eolang</groupId>
<artifactId>jucs</artifactId>
<version>0.0.0</version>
</dependency>
```

Then, to iterate over the `*.yaml` files in the `src/test/resources/org/example/`
Then, to iterate over the `*.yaml` files in
the `src/test/resources/org/example/`
directory (assuming you use Maven or Gradle):

```java
Expand All @@ -48,13 +53,16 @@ in the [objectionary/eo](https://github.com/objectionary/eo) repository.

## How to Contribute

Fork repository, make changes, send us a [pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html).
Fork repository, make changes, send us a [
pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html).

Check failure on line 57 in README.md

View workflow job for this annotation

GitHub Actions / markdown-lint

Spaces inside link text [Context: "[ pull request]"]
We will review your changes and apply them to the `master` branch shortly,
provided they don't violate our quality standards. To avoid frustration,
before sending us your pull request please run full Maven build:

```bash
$ mvn clean install -Pqulice
mvn clean install -Pqulice
```

You will need Maven 3.3+ and Java 8+.

[annotation]: https://www.javadoc.io/doc/org.eolang/jucs/latest/org/eolang/jucs/ClasspathSource.html

0 comments on commit 9f01ae0

Please sign in to comment.