GitHub Action
Assignmenty Bot
Just Code and Push , Leave The Assignment Part on us....Happy Coding </>
-
This is a GitHub Action to create your assignment automatically with help of version control.
-
It takes code and snaps from your latest commit and make it an assignment and send you in mail📧
-
This action runs in a Docker container and therefore only supports Linux🐧
- Create you coding assignments like
``` This is Your Question , Write Questions like this``` def code(): this is your code. Just code anything
- Save the code file as
assignment12.py
orassignment34.py
This action currently supports only Python Code Assignments 🐍
but this GitHub Action can me modified for any code based asssignments.Feel free to contribute.🤗- You can use this example to work it out 🧐
- create a github repo and clone it, then add a action config (
.yml
) file.Steps are avialablehere for more info 🤔 - Add a template docx file and name it
tmplate.docx
or use my template and modify it. Check the template here 📑 - save the template file , action config file in your github repo 🐙
- Push your code with snaps and Enjoy 😍
The following example workflow step will get your latest commit and take the code file and snaps to form a .docx
based assignment and send you via mail.
-
name: Assignmenty Mailer on: push: branches: - main workflow_dispatch: jobs: mailer: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 with: fetch-depth: 2 - uses: ShreyamMaity/Assignmenty@main with: MAILID : 'sample@gmail.com' #mail if of your choice FILENAME : 'assignment' #assignment file name
Just copy the above code and paste it in your .yml
file
The following input variable options can/must be configured:
Input variable | Necessity | Description |
---|---|---|
MAILID |
Required | your mail id where you want to recieve the assignment |
FILENAME |
Required | your assignment file name |
-
- Create a
.github/workflows
directory in your repository on GitHub if this directory does not already exist. - In the
.github/workflows
directory, create a file namedmailer.yml
. - open the
mailer.yml
file and paste this code :name: Assignmenty Mailer on: push: branches: - main workflow_dispatch: jobs: mailer: runs-on: ubuntu-latest steps: - uses: actions/checkout@v2 with: fetch-depth: 2 - uses: ShreyamMaity/Assignmenty@main with: MAILID : 'sample@gmail.com' #mail if of your choice FILENAME : 'assignment' #assignment file name
- Create a
-
- go to the
Actions
tab in your github repository - press
set up a workflow yourself
- Delete the base code and paste above code
- start commit
- and all set
- go to the
The Copy Paste GitHub action is written by Shreyam Maity
This project is licensed under the MIT License - see the LICENSE file for details.