GithubHelp home page GithubHelp logo

Comments (4)

nightroman avatar nightroman commented on May 27, 2024

@lzybkr, are you aware that anything.build.ps1 is the default build script if it is the only like *.build.ps1 in the same directory?

from invoke-build.

nightroman avatar nightroman commented on May 27, 2024

.build.ps1 takes over only in the case of 2+ *.build.ps1 files in the same
directory. This case is so rare that I think we should not really care of it.
The only known example is the directory with IB Tests.

The suggested directoryname.build.ps1 looks promising but it is not "portable".
Renaming a directory may break things inside, this is not quite right.

In other words, I do not think any change is needed. Except perhaps improving
the manuals or examples, so that users do not think that .build.ps1 is the
only possible default script. What do you think?

from invoke-build.

lzybkr avatar lzybkr commented on May 27, 2024

Sure, documentation could be improved. I see plenty of examples using .build.ps1 in https://github.com/nightroman/Invoke-Build/wiki/Build-Scripts-in-Projects

It does seem like you should active discourage using that filename though - it will only be confusing on Linux.

from invoke-build.

nightroman avatar nightroman commented on May 27, 2024

Yes, nowadays <project-name>.build.ps1 should be recommended as a build
script name, not the shortest possible and ultimate default .build.ps1.

.build.ps1 was never recommended, if you read the help and wiki. It just
happened that I used this name in my projects. You find this name weird.
I find it convenient for quite a few reasons. "Default" is a convention.
There will be always folks who like and dislike your choice.

<project-name>.build.ps1 is the default build script right away, this
was supported from the very beginning, with a caveat: it should be the
only build script in its directory. This is almost always the case.

I reviewed the help and wiki and tweaked a little bit.
I added the explicit first line note to Build-Scripts-in-Projects.

I do not think it will be needed but in the future we may reconsider the
ultimate default which is currently .build.ps1. In fact, there will be use
cases when having it as "hidden" is a convenience. For example, Plaster
default build scripts are not supposed to be modified by users.

from invoke-build.

Related Issues (20)

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.