https://github.com/bryantson/universities-list-actions

GitHub Actions that searches for list of universities in a country
https://github.com/bryantson/universities-list-actions

actions colleges github-actions universities

Last synced: 9 months ago
JSON representation

GitHub Actions that searches for list of universities in a country

• Host: GitHub
• URL: https://github.com/bryantson/universities-list-actions
• Owner: bryantson
• Created: 2022-03-07T02:14:31.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-07-10T05:11:45.000Z (almost 3 years ago)
• Last Synced: 2025-09-13T18:48:26.023Z (9 months ago)
• Topics: actions, colleges, github-actions, universities
• Homepage:
• Size: 950 KB
• Stars: 3
• Watchers: 1
• Forks: 11
• Open Issues: 4
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# Search for universities and colleges in a country

This fun and useful GitHub Actions plugin lets you search for colleges and universities in a country. Thank you Hipolabs for providing free API endpoint: `http://universities.hipolabs.com/search?country=`

### How to run?

This Actions only take one single input value `country`, which can be a word separate a single space (e.g. United States). Below shows an example of a GitHub Actions pipeline file named `main.yml` that can be put under `.github/workflows` folder to execute.

```yaml

name: Test custom GitHub Action

on:

  workflow_dispatch:

    inputs:

      country:

        description: Please type in name of country.

        required: true

        default: 'United States'

jobs:

  university_search_job:

    runs-on: ubuntu-latest

    name: A job to search by university

    steps:

      - name: Checkout files

        uses: actions/checkout@v2

        

      - name: University search

        uses: bryantson/universities-list-actions@v1

        id: search-university

        with:

          country: ${{ github.event.inputs.country }}

```

### What output looks like?

Everything gets printed inside a GitHub log. You can find university/college names sorted alphabetically in ascending order and their associated website links. A screenshot below shows a sample output.

![Sample output](./images/sample_output.jpg)

You can also print total number of univerisites with `total` output. For example, you can add a print statement in a step like this in your Actions workflow to print that number.

```yaml

- name: University search

  uses: bryantson/universities-list-actions@v1

  id: search-university

  with:

    country: ${{ github.event.inputs.country }}

- name: Get the output total

  run: echo "The total number of universities is ${{ steps.search-university.outputs.total }}"

```

### How to contribute?

As this is a simple GitHub Actions based on a public API, feel free to fork and to modify based on MIT license :)

### License

[MIT](https://tldrlegal.com/license/mit-license) @ [bryantson](https://github.com/bryantson)