Skip to content

Just Code and Push , Leave The Assignment Part on us....

License

Notifications You must be signed in to change notification settings

ShreyamMaity/Assignmenty

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

8 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Assignmenty Bot

Star Badge


Just Code and Push , Leave The Assignment Part on us....Happy Coding </>

Assignmenty.mp4

  • This is a GitHub Action to create your assignment automatically with the help of git 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🐧

  • Watch Full Config Video Here


Prep Work

  1. Create you coding assignments like or Watch Config Video Here
    ``` This is Your Question , Write Questions like this```
    
    def code():
        this is your code. Just code anything
    
  2. Save the code file as assignment12.py or assignment34.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 🧐
  3. create a github repo and clone it, then add a action config (.yml) file.Steps are avialable here for more info 🤔
  4. Add a template docx file and name it tmplate.docx or use my template and modify it. Check the template here 📑
  5. save the template file , action config file in your github repo 🐙
  6. Push your code with snaps and Enjoy 😍

Usage :

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 : '[email protected]' #mail if of your choice
            FILENAME : 'assignment' #assignment file name

Just copy the above code and paste it in your .yml file or watch this video to understand how to config.Watch Config Video Here


Options ⚙️

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

Action Config Guide

  • Dir Methord :

    • 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 named mailer.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 : '[email protected]' #mail if of your choice
              FILENAME : 'assignment' #assignment file name
  • UI Methord :

    • 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

Author

The Copy Paste GitHub action is written by Shreyam Maity


License

This project is licensed under the MIT License - see the LICENSE file for details.