Verify version number in platform.txt when generating release package

[sticilface]

A version.txt file is required to keep platformio happy.

When it is placed in the project root the entire esp8266 directory can be symlinked into platformio and it works with no modification.

I Can just add a version.txt file, but it might be nice to have one generated that matches the project version or git.. if this is possible? Can just contain a 1 if not..

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

[Links2004]

you can add a call like this:

ver=`git describe --tags --always`
echo esp8266-$ver > version.txt

(this is bash not python)

to tools/get.py

for the release build here:
package/build_boards_manager_package.sh

[sticilface]

Would this be a way to do it for everyone?

ps. i've not touched python, ever... in fact i tried once and broke everything...

[sticilface]

Further discoveries. This file should actually contain the arduino version so in this case
10606. Any objections to putting this file in the project root?

[igrr]

The core is not bound to a particular version of the IDE. It would be a bit
strange to include a version.txt with a value which doesn't match core's
version. Perhaps we can generate this file automatically from platformio?

On Sat, Jan 2, 2016, 12:45 sticilface notifications@github.com wrote:

Further discoveries. This file should actually contain the arduino version
so in this case
10606. Any objections to putting this file in the project root?

—
Reply to this email directly or view it on GitHub
#1339 (comment).

[ivankravets]

@igrr where I can get valid version? What is it? https://github.com/esp8266/Arduino/blob/master/platform.txt#L9

[igrr]

We can generate version.txt inside the released archive automatically, if it helps. Alternatively, you can parse the release archive name (it looks like esp8266-<version>.zip).

[ivankravets]

I see that you have this info in platform.txt. We will use it. See platformio/platformio-core#548

You can close this issue.

[igrr]

Ah, okay, then we need to make sure the version in platform.txt matches the real version.

[ivankravets]

@igrr we have interesting issue platformio/platformio-core#479 where we will propose different vendors to create own development platform compatible with PlatformIO. In this case, this platform will depend on the different pre-built packages and will contain own build scripts.

Ideally, will be good to have some manifest file per package. Package is generic meaning. JS developers mean under it node/npm based package, Python devs mean under it PyPi package and etc.

How about to place this info to the repo?
package.json

{
  "name": "framework-arduino-esp8266",
  "description": "ESP8266 core for Arduino",
  "repository": {
    "type": "git",
    "url": "https://github.com/esp8266/Arduino.git"
  },
  "version": "2.1.0",
  "license": "GPL v2.0",
  "authors": [
    {
       "name": "Ivan Grokhotkov",
       "email": "mail@example.com"
    },
    {
       "name": "Other Author",
       "email": "mail@example.com"
    }
  ]
}

You correct any fields. This will allow to have independent MANIFEST for the different IDE, build systems and etc.

Comments are welcome.

[igrr]

Does this file have to be in the repository, or just in the released zip package? I'm not really familiar with PlatformIO internals. Will it really use this git URL provided in manifest, or will it use a released zip package? Released package has a number of differences from the contents of git repository.

[ivankravets]

I propose to place it directly in the repository. This file will not have any relation to PlatformIO. It can be used by other build system, IDEs and etc.

Released package has a number of differences from the contents of git repository.

Hm... I didn't know. How do our users use the latest ESP8266 core using git clone? Which is difference?