Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/svrooij/dotnet-feeder
A dotnet tool for parsing rss feeds and modifying a markdown file
https://github.com/svrooij/dotnet-feeder
automation blog hacktoberfest readme-profile
Last synced: 23 days ago
JSON representation
A dotnet tool for parsing rss feeds and modifying a markdown file
- Host: GitHub
- URL: https://github.com/svrooij/dotnet-feeder
- Owner: svrooij
- License: mit
- Created: 2022-06-01T12:25:28.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-24T06:48:55.000Z (3 months ago)
- Last Synced: 2024-10-11T14:14:01.091Z (about 1 month ago)
- Topics: automation, blog, hacktoberfest, readme-profile
- Language: C#
- Homepage: https://svrooij.io/2022/06/09/building-github-action-in-net/#post
- Size: 69.3 KB
- Stars: 8
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# dotnet-feeder
Dotnet Feeder is a collection of handy tools to do stuff with markdown files. It's all build in .NET 6 and available as a [dotnet-tool](https://docs.microsoft.com/en-us/dotnet/core/tools/global-tools). Some features can also be used as a Github Action.
[![github issues][badge_issues]][link_issues]
[![License][badge_license]](link_license)
[![Support me on Github][badge_sponsor]][link_sponsor]
## Feed command
Use this command to read a json post feed and to replace the text between the tags with a list of posts.
You can use this command to automatically update any markdown with the latest posts.
I developed this to update my [Github profile readme](https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-github-profile/customizing-your-profile/managing-your-profile-readme) every day.
Be sure to add at least one file that has both the start tag `` and the end tag ``.
```plain
Feeder v1.0.0
USAGE
dotnet-feeder feed [options]
DESCRIPTION
Read a feed and write markdown
PARAMETERS
* url Url of the feed to parse
* files File(s) to write posts to
OPTIONS
--count Number of items to use Default: "10".
--tag Tag to look for, / Default: "posts".
--template Item template when writing markdown Default: "- [{title}]({url})".
--ci Running in CI env, creates github logging Environment variable: CI. Default: "False".
--wordpress Wordpress api has a different format Default: "False".
-h|--help Shows help text.
```
### Feed command - Github actions
To use this action for your own README file, do the following:
1. Add a header to your README (posts need their own header right?) `## Recent posts`
2. Skip a line and add `` to it.
3. Create a workflow like the one below
4. Change the feed parameter (or leave it if you want to promote my posts)
```yaml
on:
schedule:
- cron: '45 6 * * *'
workflow_dispatch:
jobs:
update-readme:
runs-on: ubuntu-latest
permissions:
contents: write
steps:
- uses: actions/checkout@v3
- name: Dotnet-feeder
uses: svrooij/dotnet-feeder@main
with:
feed: https://svrooij.io/feed.json
files: ./README.md
- uses: stefanzweifel/git-auto-commit-action@v4
with:
commit_message: Posts refreshed
file_pattern: README.md
```
This workflow will trigger daily at 6:45 and can be triggered from the actions screen (or other repositories :wink:)
### Support for wordpress blogs
Each wordpress website has (be default) a json api enabled. This feed is available at `https://{your-wordpress-site}/wp-json/wp/v2/posts?_fields=id,title,link` but this uses a different format. For wordpress sites we created a separate action. In the github action you should add it like this:
```yaml
- name: Dotnet-feeder
uses: svrooij/dotnet-feeder/wordpress@main
with:
site: https://svrooij.io
files: ./README.md
extra_args: --wordpress
```
## Sample posts from my blog
By running `dotnet-feeder feed https://svrooij.io/feed.json ./README.md --count 5 --tag s_posts` your can generate the section below.
- [Kiota serializing](https://svrooij.io/2024/08/20/kiota-serializing/)
- [Hyper-V template for Intune](https://svrooij.io/2024/08/02/hyper-v-template-intune/)
- [Integration tests on protected API](https://svrooij.io/2024/07/10/integration-tests-protected-api/)
- [Kiota with dependency injection](https://svrooij.io/2024/07/03/kiota-dependency-injection/)
- [Authentication using certificate - Entra ID](https://svrooij.io/2024/06/05/authentication-certificate-key-vault/)
## Developer stuff
[![github issues][badge_issues]][link_issues]
[![Support me on Github][badge_sponsor]][link_sponsor]
This repository contains of the following files:
| Path | Name | Description |
|------|------|-------------|
| `action.yml` | Action configuration | Action file for this action to be executable from other repositories. |
| `.github/workflows/build.yml` | Build workflow | Workflow for running the tests and creating the [docker image](https://github.com/svrooij/dotnet-feeder/pkgs/container/dotnet-feeder) |
| `.github/workflows/refresh.yml` | Sample workflow | Sample workflow to refresh the posts in the readme. |
| `src/*` | dotnet-feeder source | The actual .NET application running this stuff, using [CliFx](https://github.com/Tyrrrz/CliFx) (it's awesome) |
| `tests/*` | tests | Some tests that are mandatory in the build/release pipeline |
If you want to create your own github action in .NET code, this repository is a great place to start. Let me know what you think!
[badge_issues]: https://img.shields.io/github/issues/svrooij/dotnet-feeder?style=flat-square
[badge_license]: https://img.shields.io/github/license/svrooij/dotnet-feeder?style=flat-square
[badge_sponsor]: https://img.shields.io/badge/Sponsor-at%20Github-red?style=flat-square
[link_issues]: https://github.com/svrooij/dotnet-feeder/issues
[link_license]: https://github.com/svrooij/dotnet-feeder/blob/main/LICENSE
[link_sponsor]: https://github.com/sponsors/svrooij