Megalinter support #57

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged

gabrielbmoro merged 13 commits into master from feature/megalinter-support

May 23, 2025

.github/PULL_REQUEST_TEMPLATE.md

-Original file line number
+Diff line change
@@ Expand Up / @@ -20,4 +20,5 @@ @@
     ## Issues Relacionadas
     [Adicione as issues relacionadas a esse PR, se houver.]
-    - [link da issue 1]
+    - [link da issue 1]

.github/workflows/build.yml

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -2,9 +2,9 @@ name: Build KMP (Android + iOS)
  
    on:

      push:

        branches: [ master ]

        branches: [master]

      pull_request:

        branches: [ master ]

        branches: [master]

      workflow_dispatch:

        inputs:

          run_ios:

    @@ -29,7 +29,7 @@ jobs:
  
          - name: Setup JDK

            uses: actions/setup-java@v3

            with:

              distribution: 'temurin'

              distribution: "temurin"

              java-version: 17

          - name: Grant permission to gradlew

.github/workflows/mega-linter.yml

-Original file line number
+Diff line change
@@ -0,0 +1,42 @@
+    # MegaLinter GitHub Action configuration file
+    # More info at https://megalinter.io
+    ---
+    name: MegaLinter
+    on:
+      pull_request:
+        branches:
+          - master
+    concurrency:
+      group: ${{ github.ref }}-${{ github.workflow }}
+      cancel-in-progress: true
+    jobs:
+      megalinter:
+        name: MegaLinter
+        runs-on: ubuntu-latest
+        # Give the default GITHUB_TOKEN write permission to commit and push, comment
+        # issues, and post new Pull Requests; remove the ones you do not need
+        permissions:
+          contents: write
+          pull-requests: write
+        steps:
+          # Git Checkout
+          - name: Checkout Code
+            uses: actions/checkout@v4
+            with:
+              token: ${{ secrets.PAT || secrets.GITHUB_TOKEN }}
+              fetch-depth: 0
+          # MegaLinter
+          - name: MegaLinter
+            uses: oxsecurity/megalinter/flavors/java@v8
+            id: ml
+            env:
+              VALIDATE_ALL_CODEBASE: true
+              GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.markdownlint.json

-Original file line number
+Diff line change
@@ -0,0 +1,5 @@
+    {
+      "MD033": {
+        "allowed_elements": ["img", "a"]
+      }
+    }

.mega-linter.yml

-Original file line number
+Diff line change
@@ -0,0 +1,34 @@
+    # Configuration file for MegaLinter
+    #
+    # See all available variables at https://megalinter.io/latest/config-file/ and in
+    # linters documentation
+    # all, none, or list of linter keys
+    APPLY_FIXES: none
+    # If you use ENABLE variable, all other languages/formats/tooling-formats will
+    # be disabled by default
+    # ENABLE:
+    # If you use ENABLE_LINTERS variable, all other linters will be disabled by
+    # default
+    ENABLE_LINTERS:
+      - YAML_PRETTIER
+      - MARKDOWN_MARKDOWNLINT
+      - KOTLIN_DETEKT
+    DISABLE:
+      - COPYPASTE # Comment to enable checks of excessive copy-pastes
+      # - SPELL # Uncomment to disable checks of spelling mistakes
+    SHOW_ELAPSED_TIME: true
+    FILEIO_REPORTER: false
+    # Uncomment if you want MegaLinter to detect errors but not block CI to pass
+    # DISABLE_ERRORS: true
+    MARKDOWN_MARKDOWNLINT_CONFIG_FILE: .markdownlint.json
+    MARKDOWN_MARKDOWNLINT_DISABLE_ERRORS: false
+    KOTLIN_DETEKT_ARGUMENTS: -c config/detekt/detekt.yml -ex "**/build/**" -p "lib/detekt-formatting-1.23.7.jar"
+    DISABLE_ERRORS: true

CONTRIBUTOR_PROJECT.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,34 +1,39 @@
  
    **1. Abra a parte de ISSUES do GitHub e escolha uma issue que você se identifica ou gostaria de explorá-la.**

    - 1.1. Caso você queira aprender algo ou quer explorar o processo de mentoria ou está na dúvida sobre o que pegar.

        - Fale com um dos membros apoiadores no grupo do Discord, no canal #projeto-netflix (Rods, Gabriel Moro ou Carlos Vacarri), para ajudar a instruí-l(a/o).

        - Essa parte da dinâmica da mentoria será moldada junto com você, então tente/tenha paciência e vamos aprender juntos!

      - Fale com um dos membros apoiadores no grupo do Discord, no canal #projeto-netflix (Rods, Gabriel Moro ou Carlos Vacarri), para ajudar a instruí-l(a/o).

      - Essa parte da dinâmica da mentoria será moldada junto com você, então tente/tenha paciência e vamos aprender juntos!

    - 1.2. Caso você queira ajudar a galera no processo de mentoria.

        - Fale com um dos membros apoiadores no grupo do Discord, no canal #projeto-netflix, e participe ajudando o pessoal lá.

        - Entre em contato conosco no Discord com Rods, Gabriel Moro ou Carlos Vacarri.

      - Fale com um dos membros apoiadores no grupo do Discord, no canal #projeto-netflix, e participe ajudando o pessoal lá.

      - Entre em contato conosco no Discord com Rods, Gabriel Moro ou Carlos Vacarri.

    - 1.3. Caso você esteja apenas procurando um pretexto para codar, fazer alguma melhoria ou porque não pegar algo divertido para fazer!

        - Siga o resto dos passos e seja bem-vindo!

      - Siga o resto dos passos e seja bem-vindo!

    - 1.4 Caso tenha sentido falta de algo que não está mapeando, crie uma issue, e fale com nossos membros apoiadores;

    - 1.5 Quer gravar video no CodandoTV do que você fez?

        - Fale com Rods! [Discord](https://discord.gg/fZMDmjKmju) / [LinkedIn](https://www.linkedin.com/in/rviannaoliveira/)

      - Fale com Rods! [Discord](https://discord.gg/fZMDmjKmju) / [LinkedIn](https://www.linkedin.com/in/rviannaoliveira/)

    **2. Associe seu nome, se não der, é porque você precisa participar do grupo `Codevs`, entre em contato com nossos membros apoiadores do discord para adicionarem você nesse grupo;**

    - 2.2. Se você quer fazer algo que ainda não tem uma issue fale com Rods para instrui-lo

    **3. Faça um fork deste repositório na sua máquina;**

    **4. Crie uma branch a partir da `master` para a sua feature;**

    ```git

    git checkout -b feature/issue

    ```

    **5. Desenvolva e teste sua feature;**

    **6. Faça commit das suas alterações:**

    ```git

    git commit -m 'Adicionando minha feature'

    ```

    **7. Faça push para o repositório remoto;**

    ```git

    git push origin minha-feature

    ```

CONTRIBUTOR_WIKI.md

-Original file line number
+Diff line change
@@ -1,22 +1,28 @@
     **1. Faça um fork do repositório**
     **2. Clone o repositório**
     ```git
     git clone https://github.com/CodandoTV/StreamPlayerApp.wiki.git
     ```
     **3. Acessa a pasta wiki**
     ```
     cd StreamPlayerApp.wiki
     ```
     **4. Faça as alterações desejadas nos arquivos da wiki;**
     **5. Commit e push das alterações para o seu repositório forked:**
     ```git
     git checkout -b "nome do seu branch"
     git add .
     git commit -m "Descrição das alterações"
     git push
     ```
     **6. Crie um novo Pull Request, escolhendo o repositório original como base e a branch com as suas alterações.**
     **7. Preencha os detalhes do PR, fornecendo um título e uma descrição clara.**
@@ Expand Down @@

README.md

            
                      Original file line number
                      Diff line number
                      Diff line change
                  
    @@ -1,11 +1,12 @@
  
    # StreamPlayerApp

    <h3 align="center"> 

    <h3 align="center">

    [![Backers on Open Collective](https://opencollective.com/stremplayerapp/backers/badge.svg)](#backers)

    [![Sponsors on Open Collective](https://opencollective.com/stremplayerapp/sponsors/badge.svg)](#sponsors)

    <a href="https://www.linkedin.com/company/codandotv"><img src="https://user-images.githubusercontent.com/5540492/212076261-85e22389-eaae-4ac0-9c9d-06196f54ac70.png" height="20px"/></a>

    <a href="https://www.youtube.com/c/CodandoTV"><img src="https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white" height="20px"/></a>

    </h3> 

    </h3>

    ![Logo do Projeto](file_readme/codandotv.png)

    @@ -20,42 +21,46 @@ StreamPlayerApp is an open source project based on the Netflix app, all of the f
  
    **Flow, Compose, Koin, NavigationCompose, Arquitetura MVVM com clean architecture entre outras ( ainda será separado um link para isso)**

    ## 🏋️‍♀️ Goal

    This project was initiated with the purpose of providing a hands-on and collaborative learning opportunity for the community. Through it, participants can improve their skills in Android development, Kotlin, clean architecture and teamwork.

    ## 💬 Communication

    We have a specific channel called [#projeto-netflix](https://discord.com/channels/843114243859546142/1101921493010616351)) in our [Discord](https://discord.gg/fZMDmjKmju) server to talk about the project.

    ------------------------------------------

    ---

    ### 🚨 If you arrived here, and you are not subscribed in our YouTube channel, this is a great moment to do that 🙏

    ### 🚨 If you arrived here, and you are not subscribed in our YouTube channel, this is a great moment to do that 🙏. 

    [![CodandoTV](https://img.shields.io/badge/YouTube-FF0000?style=for-the-badge&logo=youtube&logoColor=white)](https://bit.ly/3Ob3yPH)

    Follow our playlist of videos called [Projeto Netflix](https://www.youtube.com/playlist?list=PL-7tME9TKyA4At5ze9i8-w_trk7nXMGRj), all of the material was produced using this repository.

    ------------------------------------------

    ---

    ## ✨ How to contribute?

    If you wish to contribute to this project, chose the best path that suits you:

    1. If you want to learn something or want to explore the mentoring process or you have questions about what you should do.

        - Talk to someone in our [Discord](https://discord.gg/fZMDmjKmju), you can use the channel called  [#projeto-netflix](https://discord.com/channels/843114243859546142/1101921493010616351)(Rods, Gabriel Moro or Carlos Vaccari) to help you.

        - The mentoring will be shaped together with we do not know how it will be, so be patient and let's learn together 😊!

        - The main goal is to use the Discord as main communication tool.

       - Talk to someone in our [Discord](https://discord.gg/fZMDmjKmju), you can use the channel called [#projeto-netflix](https://discord.com/channels/843114243859546142/1101921493010616351)(Rods, Gabriel Moro or Carlos Vaccari) to help you.

       - The mentoring will be shaped together with we do not know how it will be, so be patient and let's learn together 😊!

       - The main goal is to use the Discord as main communication tool.

    2. If you want to help mentoring people:

        - Talk to someone in the Discord, use the channel `#projeto-netflix`, you can start from there helping people there.

        - Reach us in the [Discord](https://discord.gg/fZMDmjKmju) server, you can reach out Rods, Moro or Carlos Vaccari.

       - Talk to someone in the Discord, use the channel `#projeto-netflix`, you can start from there helping people there.

       - Reach us in the [Discord](https://discord.gg/fZMDmjKmju) server, you can reach out Rods, Moro or Carlos Vaccari.

    3. If you are just trying to find an excuse to code, do some fun or why do not you find something fun to do!

        - Follow the [steps](https://github.com/CodandoTV/StreamPlayerApp/blob/master/CONTRIBUTOR_PROJECT.md) and welcome!

       - Follow the [steps](https://github.com/CodandoTV/StreamPlayerApp/blob/master/CONTRIBUTOR_PROJECT.md) and welcome!

    4. If there is a lack of something that is not being mapped, there is an issue and a failure with our supporting members;

    5. If you want to record videos to be published in the CodandoTV channel showing what you did, you can:

        - Talk to Rods! [Discord](https://discord.gg/fZMDmjKmju) / [LinkedIn](https://www.linkedin.com/in/rviannaoliveira/)

       - Talk to Rods! [Discord](https://discord.gg/fZMDmjKmju) / [LinkedIn](https://www.linkedin.com/in/rviannaoliveira/)

    All contributions conditions are available here in the  [Step-by-step to be a contributor](https://github.com/CodandoTV/StreamPlayerApp/blob/master/CONTRIBUTOR_PROJECT.md)

    All contributions conditions are available here in the [Step-by-step to be a contributor](https://github.com/CodandoTV/StreamPlayerApp/blob/master/CONTRIBUTOR_PROJECT.md)

    ---

    @@ -66,7 +71,7 @@ I hope our wiki becomes richer and richer, so it will be a continuous process. T
  
    If you realize that something relevant is missing here, please vote and post a PR for the wiki as well!

    [Step-by-step](https://github.com/CodandoTV/StreamPlayerApp/blob/master/CONTRIBUTOR_WIKI.md)

    --- 

    ---

    ## 🎤 How to use the Discussions option (4th tab in our git project)

    @@ -84,15 +89,12 @@ We have a section called `discussions`, this is hosted in our repository, so we
  
    ### If you arrived here, please subscribe in our YouTube channel 😛 [Codandotv](https://bit.ly/3Ob3yPH)

    ## Contributors

    This project exists thanks to all the people who contribute.

    <a href="https://github.com/CodandoTV/StreamPlayerApp"><img src="https://opencollective.com/stremplayerapp/contributors.svg?width=890&button=false" /></a>

    License

    -------

    ## License

        Copyright 2023 Rodrigo Vianna

    @@ -107,5 +109,3 @@ License
  
        WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

        See the License for the specific language governing permissions and

        limitations under the License.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Megalinter support #57

Uh oh!

Diff view

Diff view

There are no files selected for viewing

Uh oh!