Giter VIP home page Giter VIP logo

Comments (5)

gautamkrishnar avatar gautamkrishnar commented on May 23, 2024

@fundor333 can you please elaborare what you are suggesting with a minimal example of

  • Contents of TEMPLATE.md
  • Contents of README.md
  • Contents of README.md after the blog post workflow is ran.

from blog-post-workflow.

fundor333 avatar fundor333 commented on May 23, 2024

This is my idea. You have a template clean like this If the config is set. It allways remain in this state. It's an input

TEMPLATE.md

### Hi there

- šŸ”­ Iā€™m currently working on something 
- šŸ”­ Iā€™m currently working on something 
- šŸ”­ Iā€™m currently working on something 

<!-- BLOG-POST-LIST:START -->
<!-- BLOG-POST-LIST:END -->

![forthebadge](https://forthebadge.com/images/badges/you-didnt-ask-for-this.svg)
![forthebadge](https://forthebadge.com/images/badges/powered-by-electricity.svg)
![forthebadge](https://forthebadge.com/images/badges/you-didnt-ask-for-this.svg)
![forthebadge](https://forthebadge.com/images/badges/powered-by-electricity.svg)

README is the output of the workflow.

README.md before the blog post workflow is ran

### Hi there

- šŸ”­ Iā€™m currently working on something 
- šŸ”­ Iā€™m currently working on something 
- šŸ”­ Iā€™m currently working on something 

<!-- BLOG-POST-LIST:START -->
* OLD POST
* OLD POST
* OLD POST
<!-- BLOG-POST-LIST:END -->

![forthebadge](https://forthebadge.com/images/badges/you-didnt-ask-for-this.svg)
![forthebadge](https://forthebadge.com/images/badges/powered-by-electricity.svg)
![forthebadge](https://forthebadge.com/images/badges/you-didnt-ask-for-this.svg)
![forthebadge](https://forthebadge.com/images/badges/powered-by-electricity.svg)

README.md after the blog post workflow is ran

### Hi there

- šŸ”­ Iā€™m currently working on something 
- šŸ”­ Iā€™m currently working on something 
- šŸ”­ Iā€™m currently working on something 

<!-- BLOG-POST-LIST:START -->
* NEW POST
* NEW POST
* NEW POST
<!-- BLOG-POST-LIST:END -->

![forthebadge](https://forthebadge.com/images/badges/you-didnt-ask-for-this.svg)
![forthebadge](https://forthebadge.com/images/badges/powered-by-electricity.svg)
![forthebadge](https://forthebadge.com/images/badges/you-didnt-ask-for-this.svg)
![forthebadge](https://forthebadge.com/images/badges/powered-by-electricity.svg)

If you have a complex README or a long one you can edit without having conflict or without "spam" if you have a long output for blog-post-workflow

from blog-post-workflow.

gautamkrishnar avatar gautamkrishnar commented on May 23, 2024

@fundor333 In my opinion, this will add additional confusion to the users. Even if you add this template thing the readme will be committed with the changes. Lets me explain with an example:

  • You had 3 blog posts on your blog, following is the state of your readme:
<!-- BLOG-POST-LIST:START -->
* OLD POST
* OLD POST
* OLD POST
<!-- BLOG-POST-LIST:END -->

# Skills
- Java
  • You cloned the above project to your local by running:
git clone https://github.com/fundor333/fundor333.git
  • Now you have the local clone that is synced with the upstream.
  • Lets say you published a new blog post on your site
  • blog workflow ran and the following is the change that is made by the workflow:
<!-- BLOG-POST-LIST:START -->
* NEW POST
* OLD POST
* OLD POST
<!-- BLOG-POST-LIST:END -->

# Skills
- Java
  • Your locally cloned repo dont have this change it will still have:
<!-- BLOG-POST-LIST:START -->
* OLD POST
* OLD POST
* OLD POST
<!-- BLOG-POST-LIST:END -->

# Skills
- Java
  • Lets say you updated your local clone with new skill and committed it:
<!-- BLOG-POST-LIST:START -->
* OLD POST
* OLD POST
* OLD POST
<!-- BLOG-POST-LIST:END -->

# Skills
- Java
- CPP
  • Now if you try to push it, you may have conflicts.

Its unecessary to implement this feature, Please follow standard git folws. it is a standard git workflow to take the puil and fxing conflicts before committing.

from blog-post-workflow.

gautamkrishnar avatar gautamkrishnar commented on May 23, 2024

also this workflow will update the readme only if you wrote a blog post while you did the local change of the code, it is too unlikely to happen in the most cases. Readme will not be updated all the time when this workflow is run, it will update only if there is a change in the RSS feed.

from blog-post-workflow.

gautamkrishnar avatar gautamkrishnar commented on May 23, 2024

The changes made by the workflow will be also extremely minimal, i dont think that there is no problem in fixing the merge conflicts if you follow the correct git workflow.
Eg: ayushi7rawat/ayushi7rawat@5f65089

from blog-post-workflow.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    šŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. šŸ“ŠšŸ“ˆšŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ā¤ļø Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.