Giter Club home page Giter Club logo

Comments (6)

aaron-lane avatar aaron-lane commented on August 27, 2024 1

Fixed by #26.

from terraform-google-module-template.

aaron-lane avatar aaron-lane commented on August 27, 2024

terraform-docs outputs our license comment along with the inputs table and the outputs table. If that license comment is not present in the module files then combine_docfiles.py will fail to generate the documentation for the particular module. The work-around is to add the missing license comment to the files. make check_headers will indicate which files are missing headers.

from terraform-google-module-template.

morgante avatar morgante commented on August 27, 2024

Is this a bug? We expect all files to have a license header.

from terraform-google-module-template.

aaron-lane avatar aaron-lane commented on August 27, 2024

It is indeed a bug. There is a separate check which will identify files without the license header. The documentation generation task should not fail because of an absent header.

from terraform-google-module-template.

morgante avatar morgante commented on August 27, 2024

Ok, let's mark this as a P4 then since fixing bugs in non-compliant repos aren't our main target.

from terraform-google-module-template.

ivankorn avatar ivankorn commented on August 27, 2024

@aaron-lane, this bug seems to be no longer relevant, as we don't use the script since terraform_docs.sh PR is merged

from terraform-google-module-template.

Related Issues (15)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.