Words-Really-Matter GitHub Action Enforces inclusive Word Choice In Markdown

As emphasized in the recent blog post by Dale Davis Jones and Tim Humphrey –  Words Matter: Driving Thoughtful Change Toward Inclusive Language in Technology, in today’s development world, we use words in our common vocabulary that have problematic histories. Common terms have negative and divisive origins, and it’s our responsibility as developers to change them. While it takes time to remove defaulted terminology, we created a project to begin to programmatically enforce better word choices.

Words-Really-Matter is a GitHub Action that will scan any of your Markdown documents on GitHub and automatically create a pull request to suggest better word choices in your documentation. By default, the action itself will run on a specified branch and on any push you make. The resulting pull request may not be perfect, but we hope it’s a starting point in the right direction.

GitHub PR

How it works

Curious to know how it works? It’s just bash! Below is the bulk of the logic and code for the action. It finds all Markdown files in your repository and looks for any instances of words that are determined to be problematic. We thought about making it case insensitive, but did not want to suggest possible changes to mission-critical code.

#github

What is GEEK

Buddha Community

Words-Really-Matter GitHub Action Enforces inclusive Word Choice In Markdown

Words-Really-Matter GitHub Action Enforces inclusive Word Choice In Markdown

As emphasized in the recent blog post by Dale Davis Jones and Tim Humphrey –  Words Matter: Driving Thoughtful Change Toward Inclusive Language in Technology, in today’s development world, we use words in our common vocabulary that have problematic histories. Common terms have negative and divisive origins, and it’s our responsibility as developers to change them. While it takes time to remove defaulted terminology, we created a project to begin to programmatically enforce better word choices.

Words-Really-Matter is a GitHub Action that will scan any of your Markdown documents on GitHub and automatically create a pull request to suggest better word choices in your documentation. By default, the action itself will run on a specified branch and on any push you make. The resulting pull request may not be perfect, but we hope it’s a starting point in the right direction.

GitHub PR

How it works

Curious to know how it works? It’s just bash! Below is the bulk of the logic and code for the action. It finds all Markdown files in your repository and looks for any instances of words that are determined to be problematic. We thought about making it case insensitive, but did not want to suggest possible changes to mission-critical code.

#github

Desmond  Gerber

Desmond Gerber

1624347085

How to Create a Custom GitHub Actions Using JavaScript — Beginner Level

In this blog, we are going to learn how to create our own custom GitHub action using javaScript.

Prerequisite

  • Basic JavaScript Knowledge
  • Basic Git & GitHub Knowledge

About GitHub Actions

Automate, customize, and execute your software development workflows right in your repository with GitHub Actions. You can discover, create, and share actions to perform any job you’d like, including CI/CD, and combine actions in a completely customized workflow.

Types of Actions

There are three types of actions: Docker container actions, JavaScript actions, and composite run steps actions.

JavaScript Custom Action

Let’s create a Custom GitHub Action using JavaScript by creating a public repo, once the repo is created, we can clone it to our local machine using VS Code or GitPod. You need to have Node.js 12.x or higher and npm installed on your machine to perform the steps described here. You can verify the node and npm versions with the following commands in a VS Code or GitPod terminal.

node --version 
npm --version

#github #github-tutorial #github-actions #github-trend

Spring: A Static Web Site Generator Written By GitHub Issues

Spring

Spring is a blog engine written by GitHub Issues, or is a simple, static web site generator. No more server and database, you can setup it in free hosting with GitHub Pages as a repository, then post the blogs in the repository Issues.

You can add some labels in your repository Issues as the blog category, and create Issues for writing blog content through Markdown.

Spring has responsive templates, looking good on mobile, tablet, and desktop.Gracefully degrading in older browsers. Compatible with Internet Explorer 10+ and all modern browsers.

Get up and running in seconds.

中文介绍

Quick start guide

For the impatient, here's how to get a Spring blog site up and running.

First of all

  • Fork the Spring repository as yours.
  • Goto your repository settings page to rename Repository Name.
  • Hosted directly on GitHub Pages from your project repository, you can take it as User or organization site or Project site(create a gh-pages branch).
  • Also, you can set up a custom domain with Pages.

Secondly

  • Open the index.html file to edit the config variables with yours below.
$.extend(spring.config, {
  // my blog title
  title: 'Spring',
  // my blog description
  desc: "A blog engine written by github issues [Fork me on GitHub](https://github.com/zhaoda/spring)",
  // my github username
  owner: 'zhaoda',
  // creator's username
  creator: 'zhaoda',
  // the repository name on github for writting issues
  repo: 'spring',
  // custom page
  pages: [
  ]
})
  • Put your domain into the CNAME file if you have.
  • Commit your change and push it.

And then

  • Goto your repository settings page to turn on the Issues feature.
  • Browser this repository's issues page, like this https://github.com/your-username/your-repo-name/issues?state=open.
  • Click the New Issue button to just write some content as a new one blog.

Finally

  • Browser this repository's GitHub Pages url, like this http://your-username.github.io/your-repo-name, you will see your Spring blog, have a test.
  • And you're done!

Custom development

Installation

  • You will need a web server installed on your system, for example, Nginx, Apache etc.
  • Configure your spring project to your local web server directory.
  • Run and browser it, like http://localhost/spring/dev.html .
  • dev.html is used to develop, index.html is used to runtime.

Folder Structure

spring/
├── css/
|    ├── boot.less  #import other less files
|    ├── github.less  #github highlight style
|    ├── home.less  #home page style
|    ├── issuelist.less #issue list widget style
|    ├── issues.less #issues page style
|    ├── labels.less #labels page style
|    ├── main.less #commo style
|    ├── markdown.less #markdown format style
|    ├── menu.less #menu panel style
|    ├── normalize.less #normalize style
|    ├── pull2refresh.less #pull2refresh widget style
|    └── side.html  #side panel style
├── dist/
|    ├── main.min.css  #css for runtime
|    └── main.min.js  #js for runtime
├── img/  #some icon, startup images
├── js/
|    ├── lib/  #some js librarys need to use
|    ├── boot.js  #boot
|    ├── home.js  #home page
|    ├── issuelist.js #issue list widget
|    ├── issues.js #issues page
|    ├── labels.js #labels page
|    ├── menu.js #menu panel
|    ├── pull2refresh.less #pull2refresh widget
|    └── side.html  #side panel
├── css/
|    ├── boot.less  #import other less files
|    ├── github.less  #github highlight style
|    ├── home.less  #home page style
|    ├── issuelist.less #issue list widget style
|    ├── issues.less #issues page style
|    ├── labels.less #labels page style
|    ├── main.less #commo style
|    ├── markdown.less #markdown format style
|    ├── menu.less #menu panel style
|    ├── normalize.less #normalize style
|    ├── pull2refresh.less #pull2refresh widget style
|    └── side.html  #side panel style
├── dev.html #used to develop
├── favicon.ico #website icon
├── Gruntfile.js #Grunt task config
├── index.html #used to runtime
└── package.json  #nodejs install config

Customization

  • Browser http://localhost/spring/dev.html, enter the development mode.
  • Changes you want to modify the source code, like css, js etc.
  • Refresh dev.html view change.

Building

  • You will need Node.js installed on your system.
  • Installation package.
bash

$ npm install

*   Run grunt task.

    ```bash
$ grunt
  • Browser http://localhost/spring/index.html, enter the runtime mode.
  • If there is no problem, commit and push the code.
  • Don't forget to merge master branch into gh-pages branch if you have.
  • And you're done! Good luck!

Report a bug

Who used

If you are using, please tell me.

Download Details:
Author: zhaoda
Source Code: https://github.com/zhaoda/spring
License: MIT License

#spring #spring-framework #spring-boot #java 

Arne  Denesik

Arne Denesik

1604199780

Convert Your Jupyter-notebook to Github pages with Github-action

As a data scientist and machine learning engineering, the Jupyter notebook is handy tools you can use.

How cool if you convert that notebook into a blog within less than 5 min?

And now this is possible with Github action and Fastpages templates.

You can find a live demo here.

1. Requirement

2. Step to follow

  • open Github account and use fastpages templates you can find a link here.

Image for post

  • Within 30 sec one pull request is generated by Github-action. Follow steps before you merge the pull request.

Image for post

  • Make sure you check this Allow write access.
  • Merge pull request and wait until Github-action makes Github pages.
  • Now you find a link in your Github repo readme file where you can find demo posts.

#github-pages #jupyter-notebook #github-actions #data-science #markdown

Oral  Brekke

Oral Brekke

1617437520

Deploying my portfolio website on Github Pages using Github Actions.

I recently deployed  my portfolio site and wanted to try out github actions and this is my experience of automating the deployment.

This article is more focused on how you can use the GitHub actions and how easy it is to deploy your code to GitHub pages rather than the portfolio site code.So every time you make an update or build to your website ,the changes are automatically reflected and this automated deploying process makes work much faster.

The way GitHub action works is you create actions in your repositories by creating one or more yaml files and these are called workflows.Workflows now can handle build tasks like CI CD. This means you use the action to test your code and push the site to the desired hosting platform (in this case GitHub pages ) when the main branch changes .

First step assuming that you have a GitHub account is to create a repository having your website code in it.Now I have a bootstrap website but in the future I do plan on adding node JS so I already added package.json.

#workflow #portfolio #github #github-actions #github-pages